nua
1.12.11devel
|
Sofia-SIP User Agent Library API. More...
#include <sofia-sip/su_wait.h>
#include <sofia-sip/url.h>
#include <sofia-sip/sip.h>
#include <sofia-sip/nua_tag.h>
Macros | |
#define | NUA_H |
Defined when <sofia-sip/nua.h> has been included. More... | |
#define | NUA_VERSION |
NUA API version. | |
#define | nua_handle_home(nh) |
Cast a nua_handle_t pointer to a su_home_t. More... | |
Typedefs | |
typedef NUA_MAGIC_T | nua_magic_t |
Application context for NUA agent. More... | |
typedef NUA_HMAGIC_T | nua_hmagic_t |
Application context for NUA handle. More... | |
typedef enum nua_nw_detector_e | nua_nw_detector_t |
Network change event levels given to NUTAG_DETECT_NETWORK_UPDATES(). More... | |
typedef enum nua_event_e | nua_event_t |
Events. | |
typedef void(* | nua_callback_f) (nua_event_t event, int status, char const *phrase, nua_t *nua, nua_magic_t *magic, nua_handle_t *nh, nua_hmagic_t *hmagic, sip_t const *sip, tagi_t tags[]) |
Typedef of NUA event callback. More... | |
typedef NUA_SAVED_EVENT_T | nua_saved_event_t |
Abstract type for saved nua events. More... | |
Enumerations |
Functions | |
nua_t * | nua_create (su_root_t *root, nua_callback_f callback, nua_magic_t *magic, tag_type_t tag, tag_value_t value,...) |
Create a NUA agent. More... | |
void | nua_shutdown (nua_t *nua) |
Shutdown NUA stack. More... | |
void | nua_destroy (nua_t *nua) |
Destroy the NUA stack. More... | |
nua_magic_t * | nua_magic (nua_t *nua) |
Fetch callback context from nua. More... | |
void | nua_set_params (nua_t *, tag_type_t, tag_value_t,...) |
Set NUA parameters. More... | |
void | nua_get_params (nua_t *nua, tag_type_t, tag_value_t,...) |
Get NUA parameters. More... | |
nua_handle_t * | nua_default (nua_t *nua) |
Obtain default operation handle of the NUA stack object. More... | |
nua_handle_t * | nua_handle (nua_t *nua, nua_hmagic_t *hmagic, tag_type_t, tag_value_t,...) |
Create an operation handle. More... | |
void | nua_handle_destroy (nua_handle_t *h) |
Destroy a handle. More... | |
nua_handle_t * | nua_handle_ref (nua_handle_t *) |
Make a new reference to handle. More... | |
int | nua_handle_unref (nua_handle_t *) |
Destroy reference to handle. More... | |
void | nua_handle_bind (nua_handle_t *nh, nua_hmagic_t *magic) |
Bind a callback context to an operation handle. More... | |
nua_hmagic_t * | nua_handle_magic (nua_handle_t *nh) |
Fetch a callback context from an operation handle. More... | |
void | nua_set_hparams (nua_handle_t *, tag_type_t, tag_value_t,...) |
Set handle parameters. More... | |
void | nua_get_hparams (nua_handle_t *, tag_type_t, tag_value_t,...) |
Get handle parameters. More... | |
int | nua_handle_has_invite (nua_handle_t const *nh) |
Check if operation handle is used for INVITE. More... | |
int | nua_handle_has_subscribe (nua_handle_t const *nh) |
Check if operation handle has been used with outgoing SUBSCRIBE of REFER request. More... | |
int | nua_handle_has_register (nua_handle_t const *nh) |
Check if operation handle has been used with nua_register() or nua_unregister(). More... | |
int | nua_handle_has_active_call (nua_handle_t const *nh) |
Check if operation handle has an active call. More... | |
int | nua_handle_has_call_on_hold (nua_handle_t const *nh) |
Check if operation handle has a call on hold. More... | |
int | nua_handle_has_events (nua_handle_t const *nh) |
Check if handle has active event subscriptions (refers sent). More... | |
int | nua_handle_has_registrations (nua_handle_t const *nh) |
Check if operation handle has active registrations. More... | |
sip_to_t const * | nua_handle_remote (nua_handle_t const *nh) |
Get the remote address (From/To header) of operation handle. More... | |
sip_to_t const * | nua_handle_local (nua_handle_t const *nh) |
Get the local address (From/To header) of operation handle. More... | |
char const * | nua_event_name (nua_event_t event) |
Get name for NUA event. More... | |
char const * | nua_callstate_name (enum nua_callstate state) |
Get name for NUA callstate. More... | |
char const * | nua_substate_name (enum nua_substate substate) |
Return name of subscription state. More... | |
enum nua_substate | nua_substate_make (char const *sip_substate) |
Convert string to enum nua_substate. More... | |
void | nua_register (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Send SIP REGISTER request to the registrar. More... | |
void | nua_unregister (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Unregister. More... | |
void | nua_invite (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Place a call using SIP INVITE method. More... | |
void | nua_ack (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Acknowledge a succesfull response to INVITE request. More... | |
void | nua_prack (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Acknowledge a reliable preliminary response to INVITE request. More... | |
void | nua_options (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Query capabilities from server. More... | |
void | nua_publish (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Send PUBLISH request to publication server. More... | |
void | nua_unpublish (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Send un-PUBLISH request to publication server. More... | |
void | nua_message (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Send an instant message. More... | |
void | nua_chat (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Send a chat message. More... | |
void | nua_info (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Send an INFO request. More... | |
void | nua_subscribe (nua_handle_t *nh, tag_type_t, tag_value_t,...) |
Subscribe a SIP event. More... | |
void | nua_unsubscribe (nua_handle_t *, tag_type_t, tag_value_t,...) |
Unsubscribe an event. More... | |
void | nua_notify (nua_handle_t *, tag_type_t, tag_value_t,...) |
Send a NOTIFY message. More... | |
void | nua_notifier (nua_handle_t *, tag_type_t, tag_value_t,...) |
Create an event server. More... | |
void | nua_terminate (nua_handle_t *, tag_type_t, tag_value_t,...) |
Terminate an event server. More... | |
void | nua_refer (nua_handle_t *, tag_type_t, tag_value_t,...) |
Transfer a call. More... | |
void | nua_update (nua_handle_t *, tag_type_t, tag_value_t,...) |
Update a call. More... | |
void | nua_bye (nua_handle_t *, tag_type_t, tag_value_t,...) |
Hangdown a call. More... | |
void | nua_cancel (nua_handle_t *, tag_type_t, tag_value_t,...) |
Cancel an INVITE operation. More... | |
void | nua_authenticate (nua_handle_t *, tag_type_t, tag_value_t,...) |
Authenticate an operation. More... | |
void | nua_authorize (nua_handle_t *, tag_type_t, tag_value_t,...) |
Authorize a subscriber. More... | |
void | nua_method (nua_handle_t *, tag_type_t, tag_value_t,...) |
Send a request message with an extension method. More... | |
void | nua_respond (nua_handle_t *nh, int status, char const *phrase, tag_type_t, tag_value_t,...) |
Respond to a request with given status code and phrase. More... | |
int | nua_event_is_incoming_request (nua_event_t e) |
Check if event can be responded with nua_respond() More... | |
char const * | nua_generate_instance_identifier (su_home_t *) |
Generate an instance identifier. More... | |
int | nua_save_event (nua_t *nua, nua_saved_event_t return_saved[1]) |
Save last nua event. More... | |
nua_event_data_t const * | nua_event_data (nua_saved_event_t const saved[1]) |
Get information from saved event. More... | |
void | nua_destroy_event (nua_saved_event_t *saved) |
Destroy a save nua event. | |
msg_t * | nua_saved_event_request (nua_saved_event_t const *saved) |
Get request message from saved nua event. More... | |
msg_t * | nua_current_request (nua_t const *nua) |
Get current request message. More... | |
sip_replaces_t * | nua_handle_make_replaces (nua_handle_t *nh, su_home_t *home, int early_only) |
Generate a Replaces header for handle. More... | |
nua_handle_t * | nua_handle_by_replaces (nua_t *nua, sip_replaces_t const *rp) |
Obtain a new reference to an existing handle based on Replaces header. More... | |
nua_handle_t * | nua_handle_by_call_id (nua_t *nua, const char *call_id) |
Obtain a new reference to an existing handle based on Call-ID. More... | |
Variables | |
char const | nua_version [] |
NUA module version. | |
Sofia-SIP User Agent Library API.
#define NUA_H |
Defined when <sofia-sip/nua.h> has been included.
#define nua_handle_home | ( | nh | ) |
Cast a nua_handle_t pointer to a su_home_t.
typedef void(* nua_callback_f) (nua_event_t event, int status, char const *phrase, nua_t *nua, nua_magic_t *magic, nua_handle_t *nh, nua_hmagic_t *hmagic, sip_t const *sip, tagi_t tags[]) |
Typedef of NUA event callback.
typedef NUA_HMAGIC_T nua_hmagic_t |
Application context for NUA handle.
typedef NUA_MAGIC_T nua_magic_t |
Application context for NUA agent.
typedef enum nua_nw_detector_e nua_nw_detector_t |
Network change event levels given to NUTAG_DETECT_NETWORK_UPDATES().
typedef NUA_SAVED_EVENT_T nua_saved_event_t |
Abstract type for saved nua events.
enum nua_event_e |
Events.
The NUA event loop calls an event callback function when an application needs to act on something that happened in the Sofia stack. The callback function is registered when nua_create() function call is used to create the NUA stack object.
The prototype of the event callback function is:
event | Callback event identification. Always present |
status | Protocol status code. Always present |
phrase | Text corresponding to status code. Always present |
nua | Pointer to NUA stack object. Always present |
magic | Pointer to callback context from nua_create(). Always present |
nh | Pointer to operation handle. |
hmagic | Pointer to callback context from nua_handle(). |
sip | Headers in parsed incoming message. May be NULL. See also nua_current_request(). |
tags | Tag list containing more information about the state of NUA. May be empty. |
Note that the contents of the last four parameters vary depending on the event. The descriptions can be found from the description of the individual event.
The events can be divided into the following categories:
Enumerator | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nua_i_error |
Error indication. Will be sent when an internal error happened or an error occurred while responding a request.
| ||||||||||||
nua_i_invite |
Incoming call INVITE. Indication of incoming call or re-INVITE request.
If status in nua_i_invite event is below 200, the application should accept or reject the call with nua_respond(). See the NUA Call Model for the detailed explanation of various options in call processing at server end. The INVITE request takes care of session setup using SDP Offer-Answer negotiation as specified in RFC 3264 (updated in RFC 3262 section 5, RFC 3311, and RFC 3312). The Offer-Answer can be taken care by application (if NUTAG_MEDIA_ENABLE(0) parameter has been set) or by the built-in SDP Offer/Answer engine soa (by default and when NUTAG_MEDIA_ENABLE(1) parameter has been set). When soa is enabled, it will take care of parsing the SDP, negotiating the media and codecs, and including the SDP in the SIP message bodies as required by the Offer-Answer model. When soa is enabled, the SDP in the incoming INVITE is parsed and feed to a soa_session_t object. The nua_i_state event sent to the application immediately after nua_i_invite will contain the parsing results in SOATAG_REMOTE_SDP() and SOATAG_REMOTE_SDP_STR() tags. Note that currently the parser within nua does not handle MIME multipart. The SDP Offer/Answer engine can get confused if the SDP offer is included in a MIME multipart, therefore such an INVITE is rejected with 415 Unsupported Media Type error response: the client is expected to retry the INVITE without MIME multipart content. If the call is to be accepted, the application should include the SDP in the 2XX response. If soa is not disabled with NUTAG_MEDIA_ENABLE(0), the SDP should be included in the SOATAG_USER_SDP() or SOATAG_USER_SDP_STR() parameter given to nua_respond(). If it is disabled, the SDP should be included in the response message using SIPTAG_PAYLOAD() or SIPTAG_PAYLOAD_STR(). Also, the Content-Type should be set using SIPTAG_CONTENT_TYPE() or SIPTAG_CONTENT_TYPE_STR().
Call progress can be signaled with preliminary responses (with status code in the range 101..199). It is possible to conclude the SDP Offer-Answer negotiation using preliminary responses, too. If NUTAG_EARLY_ANSWER(1), SOATAG_USER_SDP() or SOATAG_USER_SDP_STR() parameter is included with in a preliminary nua_response(), the SDP answer is generated and sent with the preliminary responses, too. The preliminary responses are sent reliably if feature tag "100rel" is included in the Require header of the response or if NUTAG_EARLY_MEDIA(1) parameter has been given. The reliably delivery of preliminary responses mean that a sequence number is included in the RSeq header in the response message and the response message is resent until the client responds with a PRACK request with matching sequence number in RAck header. Note that only the "183" response is sent reliably if the NUTAG_ONLY183_100REL(1) parameter has been given. The reliable preliminary responses are acknowledged with PRACK request sent by the client. Note if the SDP offer-answer is completed with the reliable preliminary responses, the is no need to include SDP in 200 OK response (or other 2XX response). However, it the tag NUTAG_INCLUDE_EXTRA_SDP(1) is included with nua_respond(), a copy of the SDP answer generated earlier by soa is included as the message body.
When so called 2rd party call control is used, the initial INVITE may not contain SDP offer. In that case, the offer is sent by the recipient of the INVITE request (User-Agent Server, UAS). The SDP sent in 2XX response (or in a preliminary reliable response) is considered as an offer, and the answer will be included in the ACK request sent by the UAC (or PRACK in case of preliminary reliable response).
| ||||||||||||
nua_i_cancel |
Incoming INVITE has been cancelled. Incoming INVITE has been cancelled by the client.
| ||||||||||||
nua_i_ack |
Final response to INVITE has been ACKed. Final response to INVITE has been acknowledged by UAC with ACK.
| ||||||||||||
nua_i_fork |
Outgoing call has been forked. This is sent when an INVITE request is answered with multiple 2XX series responses.
| ||||||||||||
nua_i_active |
A call has been activated. This event will be sent after a succesful response to the initial INVITE has been received and the media has been activated.
| ||||||||||||
nua_i_terminated |
A call has been terminated. This event will be sent after a call has been terminated. A call is terminated, when 1) an error response (300..599) is sent to an incoming initial INVITE 2) a reliable response (200..299 or reliable preliminary response) to an incoming initial INVITE is not acknowledged with ACK or PRACK 3) BYE is received or sent
| ||||||||||||
nua_i_state |
Call state has changed. This event will be sent whenever the call state changes. In addition to basic changes of session status indicated with enum nua_callstate, the RFC 3264 SDP Offer/Answer negotiation status is also included. The tags NUTAG_OFFER_RECV() or NUTAG_ANSWER_RECV() indicate whether the remote SDP that was received was considered as an offer or an answer. Tags NUTAG_OFFER_SENT() or NUTAG_ANSWER_SENT() indicate whether the local SDP which was sent was considered as an offer or answer. If the soa SDP negotiation is enabled (by default or with NUTAG_MEDIA_ENABLE(1)), the received remote SDP is included in tags SOATAG_REMOTE_SDP() and SOATAG_REMOTE_SDP_STR(). The SDP negotiation result from soa is included in the tags SOATAG_LOCAL_SDP() and SOATAG_LOCAL_SDP_STR(). SOATAG_ACTIVE_AUDIO() and SOATAG_ACTIVE_VIDEO() are informational tags used to indicate what is the status of audio or video. Note that nua_i_state also covers the information relayed in call establisment (nua_i_active) and termination (nua_i_terminated) events.
| ||||||||||||
nua_i_outbound |
Status from outbound processing. Status from outbound engine.
| ||||||||||||
nua_i_bye |
Incoming BYE call hangup. Incoming BYE request, call hangup.
| ||||||||||||
nua_i_options |
Incoming OPTIONS. Incoming OPTIONS request. The user-agent should respond to an OPTIONS request with the same statuscode as it would respond to an INVITE request. Stack responds automatically to OPTIONS request unless OPTIONS is included in the set of application methods, set by NUTAG_APPL_METHOD(). The OPTIONS request does not create a dialog. Currently the processing of incoming OPTIONS creates a new handle for each incoming request which is not assiciated with an existing dialog. If the handle nh is not bound, you should probably destroy it after responding to the OPTIONS request.
| ||||||||||||
nua_i_refer |
Incoming REFER call transfer. Incoming REFER request used to transfer calls. The tag list will contain tag NUTAG_REFER_EVENT() with the Event header constructed from the REFER request. It will also contain the SIPTAG_REFERRED_BY() tag with the Referred-By header containing the identity of the party sending the REFER. The Referred-By structure contained in the tag is constructed from the From header if the Referred-By header was not present in the REFER request. The application can let the nua to send NOTIFYs from the call it initiates with nua_invite() if it includes in the nua_invite() arguments both the NUTAG_NOTIFY_REFER() with the handle with which nua_i_refer was received and the NUTAG_REFER_EVENT() from nua_i_refer event tags.
| ||||||||||||
nua_i_publish |
Incoming PUBLISH. Incoming PUBLISH request. In order to receive nua_i_publish events, the application must enable both the PUBLISH method with NUTAG_ALLOW() tag and the acceptable SIP events with nua_set_params() tag NUTAG_ALLOW_EVENTS(). The nua_response() call responding to a PUBLISH request must have NUTAG_WITH() (or NUTAG_WITH_THIS()/NUTAG_WITH_SAVED()) tag. Note that a successful response to PUBLISH MUST include Expires and SIP-ETag headers. The PUBLISH request does not create a dialog. Currently the processing of incoming PUBLISH creates a new handle for each incoming request which is not assiciated with an existing dialog. If the handle nh is not bound, you should probably destroy it after responding to the PUBLISH request.
| ||||||||||||
nua_i_prack |
Incoming PRACK. Incoming PRACK request. PRACK request is used to acknowledge reliable preliminary responses and it is usually sent automatically by the nua stack.
| ||||||||||||
nua_i_info |
Incoming session INFO. Incoming session INFO request.
| ||||||||||||
nua_i_update |
Incoming session UPDATE. Incoming session UPDATE request.
| ||||||||||||
nua_i_message |
Incoming MESSAGE. Incoming MESSAGE request. The MESSAGE request does not create a dialog. If the incoming MESSAGE request is not assiciated with an existing dialog the stack creates a new handle for it. If the handle nh is not bound, you should probably destroy it after responding to the MESSAGE request.
| ||||||||||||
nua_i_chat |
Incoming chat MESSAGE. Incoming chat message.
| ||||||||||||
nua_i_subscribe |
Incoming SUBSCRIBE. Incoming SUBSCRIBE request. SUBSCRIBE request is used to query SIP event state or establish a SIP event subscription.
Initial SUBSCRIBE requests are dropped with 489 Bad Event response, unless the application has explicitly included the Event in the list of allowed events with nua_set_params() tag NUTAG_ALLOW_EVENTS() (or SIPTAG_ALLOW_EVENTS() or SIPTAG_ALLOW_EVENTS_STR()). If the event has been allowed the application can decide whether to accept the SUBSCRIBE request or reject it. The nua_response() call responding to a SUBSCRIBE request must have NUTAG_WITH() (or NUTAG_WITH_THIS()/NUTAG_WITH_SAVED()) tag. If the application accepts the SUBSCRIBE request, it must immediately send an initial NOTIFY establishing the dialog. This is because the response to the SUBSCRIBE request may be lost by an intermediate proxy because it had forked the SUBSCRIBE request. SUBSCRIBE requests modifying (usually refreshing or terminating) an existing event subscription are accepted by default and a 200 OK response along with a copy of previously sent NOTIFY is sent automatically to the subscriber. By default, only event subscriptions accepted are those created implicitly by REFER request. See nua_i_refer how the application must handle the REFER requests.
Accepting the SUBSCRIBE request creates a dialog with a notifier dialog usage on the handle. The dialog usage is active, until the subscriber terminates the subscription, it times out or the application terminates the usage with nua_notify() call containing the tag NUTAG_SUBSTATE(nua_substate_terminated) or Subscription-State header with state "terminated" and/or expiration time 0. When the subscriber terminates the subscription, the application is notified of an termination by a nua_i_subscribe event with NUTAG_SUBSTATE(nua_substate_terminated) tag. When the subscription times out, nua automatically initiates a NOTIFY transaction. When it is terminated, the application is sent a nua_r_notify event with NUTAG_SUBSTATE(nua_substate_terminated) tag.
| ||||||||||||
nua_i_subscription |
Incoming subscription to be authorized. This event is launched by nua_notifier() to inform application of the current state of the subscriber. The subscriber state is included in the NUTAG_SUBSTATE() tag. If the state is nua_substate_pending or nua_substate_embryonic, application should to authorize the subscriber with nua_authorize().
| ||||||||||||
nua_i_notify |
Incoming event NOTIFY. Event for incoming NOTIFY request.
| ||||||||||||
nua_i_method |
Incoming, unknown method. Incoming extension request. The extension request does not create a dialog. If the incoming request was not assiciated with an existing dialog the stack creates a new handle for it. If the handle nh is not bound, you should probably destroy it after responding to the request.
The extension method name is in sip->sip_request->rq_method_name, too.
| ||||||||||||
nua_i_media_error |
Offer-answer error indication. Media error indication. This may be sent after an SOA operation has failed while processing incoming or outgoing call.
| ||||||||||||
nua_r_set_params |
Answer to nua_set_params() or nua_get_hparams(). Response to nua_set_params() or nua_set_hparams().
| ||||||||||||
nua_r_get_params |
Answer to nua_get_params() or nua_get_hparams().
| ||||||||||||
nua_r_shutdown |
Answer to nua_shutdown() Shutdown a nua stack. When the nua stack is shutdown, ongoing calls are released, registrations unregistered, publications un-PUBLISHed and subscriptions terminated. If the stack cannot terminate everything within 30 seconds, it sends the nua_r_shutdown event with status 500.
Answer to nua_shutdown(). Status codes
| ||||||||||||
nua_r_notifier |
Answer to nua_notifier() Answer to nua_notitier()
| ||||||||||||
nua_r_terminate |
Answer to nua_terminate() Answer to nua_terminate().
| ||||||||||||
nua_r_authorize |
Answer to nua_authorize() | ||||||||||||
nua_r_register |
Answer to outgoing REGISTER. Response to an outgoing REGISTER. The REGISTER may be sent explicitly by nua_register() or implicitly by NUA state machines. When REGISTER request has been restarted the status may be 100 even while the real response status returned is different.
| ||||||||||||
nua_r_unregister |
Answer to outgoing un-REGISTER.
| ||||||||||||
nua_r_invite |
Answer to outgoing INVITE. | ||||||||||||
nua_r_cancel |
Answer to outgoing CANCEL. The CANCEL may be sent explicitly by nua_cancel() or implicitly by NUA state machine.
| ||||||||||||
nua_r_bye |
Answer to outgoing BYE. The BYE may be sent explicitly by nua_bye() or implicitly by NUA state machine.
| ||||||||||||
nua_r_options |
Answer to outgoing OPTIONS.
| ||||||||||||
nua_r_refer |
Answer to outgoing REFER. Response to outgoing REFER.
| ||||||||||||
nua_r_publish |
Answer to outgoing PUBLISH. Response to an outgoing PUBLISH. The PUBLISH request may be sent explicitly by nua_publish() or implicitly by NUA state machine.
| ||||||||||||
nua_r_unpublish |
Answer to outgoing un-PUBLISH. Response to an outgoing un-PUBLISH.
| ||||||||||||
nua_r_info |
Answer to outgoing INFO. Response to an outgoing INFO request.
| ||||||||||||
nua_r_prack |
Answer to outgoing PRACK. Response to an outgoing PRACK request. PRACK request is used to acknowledge reliable preliminary responses and it is usually sent automatically by the nua stack.
| ||||||||||||
nua_r_update |
Answer to outgoing UPDATE. The UPDATE may be sent explicitly by nua_update() or implicitly by NUA state machine.
| ||||||||||||
nua_r_message |
Answer to outgoing MESSAGE. Response to an outgoing MESSAGE request.
| ||||||||||||
nua_r_chat |
Answer to outgoing chat message.
| ||||||||||||
nua_r_subscribe |
Answer to outgoing SUBSCRIBE. Response to an outgoing SUBSCRIBE request. The SUBSCRIBE request may have been sent explicitly by nua_subscribe() or implicitly by NUA state machine.
| ||||||||||||
nua_r_unsubscribe |
Answer to outgoing un-SUBSCRIBE. Response to an outgoing un-SUBSCRIBE.
| ||||||||||||
nua_r_notify |
Answer to outgoing NOTIFY. Response to an outgoing NOTIFY request. The NOTIFY may be sent explicitly by nua_notify() or implicitly by NUA state machine. Implicit NOTIFY is sent when an established dialog is refreshed by client or it is terminated (either by client or because of a timeout). The current subscription state is included in NUTAG_SUBSTATE() tag. The nua_substate_terminated indicates that the subscription is terminated, the notifier usage has been removed and when there was no other usages of the dialog the dialog state is also removed.
| ||||||||||||
nua_r_method |
Answer to unknown outgoing method. Response to an outgoing extension request.
| ||||||||||||
nua_r_authenticate |
Answer to nua_authenticate() Response to nua_authenticate(). Under normal operation, this event is never sent but rather the unauthenticated operation is completed. However, if there is no operation to authentication or if there is an authentication error the nua_r_authenticate event is sent to the application with the status code as follows:
| ||||||||||||
nua_i_network_changed |
Local IP(v6) address has changed.
| ||||||||||||
nua_i_register |
Incoming REGISTER. Incoming REGISTER request.
In order to receive nua_i_register events, the application must enable the REGISTER method with NUTAG_ALLOW() tag, e.g., * nua_set_params(nua; * NUTAG_APPL_METHOD("REGISTER"), * NUTAG_ALLOW("REGISTER"), * TAG_END()); * The nua_response() call responding to a REGISTER request must include NUTAG_WITH() (or NUTAG_WITH_THIS()/NUTAG_WITH_SAVED()) tag. Note that a successful response to REGISTER MUST include the Contact header bound to the the AoR URI (in To header). The REGISTER request does not create a dialog. Currently the processing of incoming REGISTER creates a new handle for each incoming request which is not assiciated with an existing dialog. If the handle nh is not bound, you should probably destroy it after responding to the REGISTER request.
|
enum nua_nw_detector_e |
Network change event levels given to NUTAG_DETECT_NETWORK_UPDATES().
void nua_ack | ( | nua_handle_t * | nh, |
tag_type_t | tag, | ||
tag_value_t | value, | ||
... | |||
) |
Acknowledge a succesfull response to INVITE request.
Acknowledge a succesful response to INVITE request.
Acknowledge a successful response (200..299) to INVITE request with the SIP ACK request message. This function is needed only if NUTAG_AUTOACK() parameter has been cleared.
nh | Pointer to operation handle |
tag,value,... | List of tagged parameters |
void nua_authenticate | ( | nua_handle_t * | nh, |
tag_type_t | tag, | ||
tag_value_t | value, | ||
... | |||
) |
Authenticate an operation.
nh | Pointer to operation handle |
tag,value,... | List of tagged parameters |
void nua_authorize | ( | nua_handle_t * | nh, |
tag_type_t | tag, | ||
tag_value_t | value, | ||
... | |||
) |
Authorize a subscriber.
After creating a local presence server by nua_notifier(), an incoming SUBSCRIBE request causes nua_i_subscription event. Each subscriber is identified with NEATAG_SUB() tag in the nua_i_subscription event. Application can either authorize the subscriber with NUTAG_SUBSTATE(nua_substate_active) or terminate the subscription with NUTAG_SUBSTATE(nua_substate_terminated).
nh | Pointer to operation handle |
tag,value,... | List of tagged parameters |
void nua_bye | ( | nua_handle_t * | nh, |
tag_type_t | tag, | ||
tag_value_t | value, | ||
... | |||
) |
Hangdown a call.
Hangdown a call using SIP BYE method. Also the media session associated with the call is terminated.
nh | Pointer to operation handle |
tag,value,... | List of tagged parameters |
char const* nua_callstate_name | ( | enum nua_callstate | state | ) |
Get name for NUA callstate.
Get name for NUA callstate.
void nua_cancel | ( | nua_handle_t * | nh, |
tag_type_t | tag, | ||
tag_value_t | value, | ||
... | |||
) |
Cancel an INVITE operation.
nh | Pointer to operation handle |
tag,value,... | List of tagged parameters |
void nua_chat | ( | nua_handle_t * | nh, |
tag_type_t | tag, | ||
tag_value_t | value, | ||
... | |||
) |
Send a chat message.
A chat channel can be established during call setup using "message" media. An active chat channel is indicated using nua_i_state event containing SOATAG_ACTIVE_CHAT() tag. Chat messages can be sent using this channel with nua_chat() function. Currently this is implemented using SIP MESSAGE requests but in future MSRP (message session protocol) will replace it.
nh | Pointer to operation handle |
tag,value,... | List of tagged parameters |
nua_t* nua_create | ( | su_root_t * | root, |
nua_callback_f | callback, | ||
nua_magic_t * |