nua  1.12.11devel
Macros | Typedefs | Enumerations | Functions | Variables
nua_tag.h File Reference

Tags for Sofia-SIP User Agent Library. More...

#include <sofia-sip/su_tag.h>
#include <sofia-sip/sdp_tag.h>
#include <sofia-sip/url_tag.h>
#include <sofia-sip/sip_tag.h>
#include <sofia-sip/nta_tag.h>
#include <sofia-sip/nea_tag.h>
#include <sofia-sip/soa_tag.h>
Include dependency graph for nua_tag.h:

Macros

#define NUA_TAG_H
 Defined when <sofia-sip/nua_tag.h> has been included. More...
 
#define NUTAG_ANY()
 Filter tag matching any nua tag. More...
 
#define NUTAG_URL(x)
 URL address from application to NUA. More...
 
#define NUTAG_WITH(x)
 Specify request to respond to. More...
 
#define NUTAG_WITH_THIS(nua)
 Specify request to respond to. More...
 
#define NUTAG_WITH_SAVED(e)
 Specify request to respond to. More...
 
#define NUTAG_DIALOG(b)
 An (extension) method is used to create dialog or refresh target. More...
 
#define NUTAG_METHOD(x)
 Extension method name. More...
 
#define NUTAG_METHOD_REF(x)
 Reference tag for NUTAG_METHOD().
 
#define NUTAG_MAX_SUBSCRIPTIONS(x)
 Set maximum number of simultaneous subscribers per single event server. More...
 
#define NUTAG_MAX_SUBSCRIPTIONS_REF(x)
 Reference tag for NUTAG_MAX_SUBSCRIPTIONS().
 
#define NUTAG_USE_DIALOG(x)
 Ask NUA to create dialog for this handle. More...
 
#define NUTAG_USE_DIALOG_REF(x)
 Reference tag for NUTAG_USE_DIALOG().
 
#define NUTAG_RETRY_COUNT(x)
 Set request retry count. More...
 
#define NUTAG_RETRY_COUNT_REF(x)
 Reference tag for NUTAG_RETRY_COUNT().
 
#define NUTAG_SOA_NAME(x)
 Name for SDP Offer-Answer session object. More...
 
#define NUTAG_SOA_NAME_REF(x)
 Reference tag for NUTAG_SOA_NAME().
 
#define NUTAG_EARLY_MEDIA(x)
 Establish early media session using 100rel, 183 responses and PRACK. More...
 
#define NUTAG_EARLY_MEDIA_REF(x)
 Reference tag for NUTAG_EARLY_MEDIA().
 
#define NUTAG_ONLY183_100REL(x)
 Require 100rel extension and PRACK only with 183 response. More...
 
#define NUTAG_ONLY183_100REL_REF(x)
 Reference tag for NUTAG_ONLY183_100REL().
 
#define NUTAG_EARLY_ANSWER(x)
 Establish early media session by including SDP answer in 1XX response. More...
 
#define NUTAG_EARLY_ANSWER_REF(x)
 Reference tag for NUTAG_EARLY_ANSWER().
 
#define NUTAG_INCLUDE_EXTRA_SDP(x)
 Include an extra copy of SDP answer in the response. More...
 
#define NUTAG_INCLUDE_EXTRA_SDP_REF(x)
 Reference tag for NUTAG_INCLUDE_EXTRA_SDP().
 
#define NUTAG_ACCEPT_MULTIPART(x)
 Enable multipart processing for received messages. More...
 
#define NUTAG_ACCEPT_MULTIPART_REF(x)
 Reference tag for NUTAG_ACCEPT_MULTIPART(). More...
 
#define NUTAG_INVITE_TIMER(x)
 Timer for outstanding INVITE in seconds. More...
 
#define NUTAG_INVITE_TIMER_REF(x)
 Reference tag for NUTAG_INVITE_TIMER().
 
#define NUTAG_SESSION_TIMER(x)
 Default session timer in seconds. More...
 
#define NUTAG_SESSION_TIMER_REF(x)
 Reference tag for NUTAG_SESSION_TIMER().
 
#define NUTAG_MIN_SE(x)
 Minimum acceptable refresh interval for session. More...
 
#define NUTAG_MIN_SE_REF(x)
 Reference tag for NUTAG_MIN_SE().
 
#define NUTAG_SESSION_REFRESHER(x)
 Specify the preferred refresher. More...
 
#define NUTAG_SESSION_REFRESHER_REF(x)
 Reference tag for NUTAG_SESSION_REFRESHER().
 
#define NUTAG_UPDATE_REFRESH(x)
 Use UPDATE as refresh method. More...
 
#define NUTAG_UPDATE_REFRESH_REF(x)
 Reference tag for NUTAG_UPDATE_REFRESH().
 
#define NUTAG_REFRESH_WITHOUT_SDP(x)
 Do not send offer in response if re-INVITE was received without SDP. More...
 
#define NUTAG_REFRESH_WITHOUT_SDP_REF(x)
 Reference tag for NUTAG_REFRESH_WITHOUT_SDP_REF().
 
#define NUTAG_AUTOALERT(x)
 Send alerting (180 Ringing) automatically (instead of 100 Trying). More...
 
#define NUTAG_AUTOALERT_REF(x)
 Reference tag for NUTAG_AUTOALERT().
 
#define NUTAG_AUTOACK(x)
 ACK automatically. More...
 
#define NUTAG_AUTOACK_REF(x)
 Reference tag for NUTAG_AUTOACK().
 
#define NUTAG_AUTOANSWER(x)
 Answer (with 200 Ok) automatically to incoming call. More...
 
#define NUTAG_AUTOANSWER_REF(x)
 Reference tag for NUTAG_AUTOANSWER().
 
#define NUTAG_ENABLEINVITE(x)
 Enable incoming INVITE. More...
 
#define NUTAG_ENABLEINVITE_REF(x)
 Reference tag for NUTAG_ENABLEINVITE().
 
#define NUTAG_ENABLEMESSAGE(x)
 Enable incoming MESSAGE. More...
 
#define NUTAG_ENABLEMESSAGE_REF(x)
 Reference tag for NUTAG_ENABLEMESSAGE().
 
#define NUTAG_ENABLEMESSENGER(x)
 Enable incoming MESSAGE with To tag. More...
 
#define NUTAG_ENABLEMESSENGER_REF(x)
 Reference tag for NUTAG_ENABLEMESSENGER().
 
#define NUTAG_AUTO302(x)
 Recurse automatically on 302 response. More...
 
#define NUTAG_AUTO302_REF(x)
 Reference tag for NUTAG_AUTO302().
 
#define NUTAG_AUTO305(x)
 Recurse automatically on 305 response. More...
 
#define NUTAG_AUTO305_REF(x)
 Reference tag for NUTAG_AUTO305().
 
#define NUTAG_AUTO100(x)
 Generate automatically 100 Trying responses. More...
 
#define NUTAG_AUTO100_REF(x)
 Reference tag for NUTAG_AUTO100().
 
#define NUTAG_MAX_RETRY_AFTER(x)
 This parameter specifies the maximum delay in seconds that stack allows for Retry-After header when it considers if it should automatically retry the request. More...
 
#define NUTAG_MAX_RETRY_AFTER_REF(x)
 Reference tag for NUTAG_MAX_RETRY_AFTER().
 
#define NUTAG_SMIME_ENABLE(x)
 Enable S/MIME. More...
 
#define NUTAG_SMIME_ENABLE_REF(x)
 Reference tag for NUTAG_SMIME_ENABLE().
 
#define NUTAG_SMIME_OPT(x)
 S/MIME Options. More...
 
#define NUTAG_SMIME_OPT_REF(x)
 Reference tag for NUTAG_SMIME_OPT().
 
#define NUTAG_SMIME_PROTECTION_MODE(x)
 S/MIME protection mode. More...
 
#define NUTAG_SMIME_PROTECTION_MODE_REF(x)
 Reference tag for NUTAG_SMIME_PROTECTION_MODE().
 
#define NUTAG_SMIME_MESSAGE_DIGEST(x)
 S/MIME digest algorithm. More...
 
#define NUTAG_SMIME_MESSAGE_DIGEST_REF(x)
 Reference tag for NUTAG_SMIME_MESSAGE_DIGEST().
 
#define NUTAG_SMIME_SIGNATURE(x)
 S/MIME signature algorithm. More...
 
#define NUTAG_SMIME_SIGNATURE_REF(x)
 Reference tag for NUTAG_SMIME_SIGNATURE().
 
#define NUTAG_SMIME_KEY_ENCRYPTION(x)
 S/MIME key encryption algorithm. More...
 
#define NUTAG_SMIME_KEY_ENCRYPTION_REF(x)
 Reference tag for NUTAG_SMIME_KEY_ENCRYPTION().
 
#define NUTAG_SMIME_MESSAGE_ENCRYPTION(x)
 S/MIME message encryption algorithm. More...
 
#define NUTAG_SMIME_MESSAGE_ENCRYPTION_REF(x)
 Reference tag for NUTAG_SMIME_MESSAGE_ENCRYPTION().
 
#define NUTAG_CERTIFICATE_DIR(x)
 X.500 certificate directory. More...
 
#define NUTAG_CERTIFICATE_DIR_REF(x)
 Reference tag for NUTAG_CERTIFICATE_DIR().
 
#define NUTAG_CERTIFICATE_PHRASE(x)
 Certificate phrase. More...
 
#define NUTAG_CERTIFICATE_PHRASE_REF(x)
 Reference tag for NUTAG_CERTIFICATE_PHRASE().
 
#define NUTAG_SIPS_URL(x)
 Local SIPS url. More...
 
#define NUTAG_SIPS_URL_REF(x)
 Reference tag for NUTAG_SIPS_URL().
 
#define NUTAG_PROXY(x)
 Outbound proxy URL. More...
 
#define NUTAG_PROXY_REF(x)
 Reference tag for NUTAG_PROXY().
 
#define NUTAG_INITIAL_ROUTE(x)
 Specify initial route set. More...
 
#define NUTAG_INITIAL_ROUTE_REF(x)
 Reference tag for NUTAG_INITIAL_ROUTE().
 
#define NUTAG_INITIAL_ROUTE_STR(x)
 Specify initial route set. More...
 
#define NUTAG_INITIAL_ROUTE_STR_REF(x)
 Reference tag for NUTAG_INITIAL_ROUTE_STR().
 
#define NUTAG_REGISTRAR(x)
 Registrar URL. More...
 
#define NUTAG_REGISTRAR_REF(x)
 Reference tag for NUTAG_REGISTRAR().
 
#define NUTAG_OUTBOUND(x)
 Outbound option string. More...
 
#define NUTAG_OUTBOUND_REF(x)
 Reference tag for NUTAG_OUTBOUND().
 
#define NUTAG_SIP_PARSER(x)
 Pointer to a customized SIP parser used with NUA. More...
 
#define NUTAG_SIP_PARSER_REF(x)
 Reference tag for NUTAG_SIP_PARSER().
 
#define NUTAG_AUTH(x)
 Authentication data ("scheme" "realm" "user" "password") More...
 
#define NUTAG_AUTH_REF(x)
 Reference tag for NUTAG_AUTH().
 
#define NUTAG_AUTH_CACHE(x)
 Authentication caching policy. More...
 
#define NUTAG_AUTH_CACHE_REF(x)
 Reference tag for NUTAG_AUTH_CACHE().
 
#define NUTAG_KEEPALIVE(x)
 Keepalive interval in milliseconds. More...
 
#define NUTAG_KEEPALIVE_REF(x)
 Reference tag for NUTAG_KEEPALIVE().
 
#define NUTAG_KEEPALIVE_STREAM(x)
 Transport-level keepalive interval for streams. More...
 
#define NUTAG_KEEPALIVE_STREAM_REF(x)
 Reference tag for NUTAG_KEEPALIVE_STREAM().
 
#define NUTAG_AUTHTIME(x)
 Lifetime of authentication data in seconds. More...
 
#define NUTAG_AUTHTIME_REF(x)
 Reference tag for NUTAG_AUTHTIME().
 
#define NUTAG_M_DISPLAY(x)
 Display name for Contact. More...
 
#define NUTAG_M_DISPLAY_REF(x)
 Reference tag for NUTAG_M_DISPLAY().
 
#define NUTAG_M_USERNAME(x)
 Username prefix for Contact. More...
 
#define NUTAG_M_USERNAME_REF(x)
 Reference tag for NUTAG_M_USERNAME().
 
#define NUTAG_M_PARAMS(x)
 URL parameters for Contact. More...
 
#define NUTAG_M_PARAMS_REF(x)
 Reference tag for NUTAG_M_PARAMS().
 
#define NUTAG_M_FEATURES(x)
 Header parameters for Contact used in registration. More...
 
#define NUTAG_M_FEATURES_REF(x)
 Reference tag for NUTAG_M_FEATURES().
 
#define NUTAG_EVENT(x)
 NUA event. More...
 
#define NUTAG_EVENT_REF(x)
 Reference tag for NUTAG_EVENT().
 
#define NUTAG_STATUS(x)
 Response status code. More...
 
#define NUTAG_STATUS_REF(x)
 Reference tag for NUTAG_STATUS().
 
#define NUTAG_PHRASE(x)
 Response phrase. More...
 
#define NUTAG_PHRASE_REF(x)
 Reference tag for NUTAG_PHRASE().
 
#define NUTAG_HANDLE(x)
 NUA Handle. More...
 
#define NUTAG_HANDLE_REF(x)
 Reference tag for NUTAG_HANDLE().
 
#define NUTAG_IDENTITY(x)
 Registration handle (used with requests and nua_respond()) (NOT YET IMPLEMENTED) More...
 
#define NUTAG_IDENTITY_REF(x)
 Reference tag for NUTAG_IDENTITY().
 
#define NUTAG_INSTANCE(x)
 Intance identifier. More...
 
#define NUTAG_INSTANCE_REF(x)
 Reference tag for NUTAG_INSTANCE().
 
#define NUTAG_NOTIFY_REFER(x)
 Refer reply handle (used with refer) More...
 
#define NUTAG_NOTIFY_REFER_REF(x)
 Reference tag for NUTAG_NOTIFY_REFER().
 
#define NUTAG_REFER_EVENT(x)
 Event used with automatic refer notifications. More...
 
#define NUTAG_REFER_EVENT_REF(x)
 Reference tag for NUTAG_REFER_EVENT().
 
#define NUTAG_REFER_PAUSE(x)
 Invite pauses referrer's handle. More...
 
#define NUTAG_REFER_PAUSE_REF(x)
 Reference tag for NUTAG_REFER_PAUSE().
 
#define NUTAG_USER_AGENT(x)
 User-Agent string. More...
 
#define NUTAG_USER_AGENT_REF(x)
 Reference tag for NUTAG_USER_AGENT().
 
#define NUTAG_ALLOW(x)
 Allow a method (or methods). More...
 
#define NUTAG_ALLOW_REF(x)
 Reference tag for NUTAG_ALLOW().
 
#define NUTAG_APPL_METHOD(x)
 Indicate that a method (or methods) are handled by application. More...
 
#define NUTAG_APPL_METHOD_REF(x)
 Reference tag for NUTAG_APPL_METHOD().
 
#define NUTAG_SUPPORTED(x)
 Support a feature. More...
 
#define NUTAG_SUPPORTED_REF(x)
 Reference tag for NUTAG_SUPPORTED().
 
#define NUTAG_ALLOW_EVENTS(x)
 Allow an event or events. More...
 
#define NUTAG_ALLOW_EVENTS_REF(x)
 Reference tag for NUTAG_ALLOW_EVENTS().
 
#define NUTAG_APPL_EVENT(x)
 List events which the application handles always. More...
 
#define NUTAG_APPL_EVENT_REF(x)
 Reference tag for NUTAG_APPL_EVENT().
 
#define NUTAG_CALLSTATE(x)
 Call state. More...
 
#define NUTAG_CALLSTATE_REF(x)
 Reference tag for NUTAG_CALLSTATE().
 
#define NUTAG_SUBSTATE(x)
 Subscription state. More...
 
#define NUTAG_SUBSTATE_REF(x)
 Reference tag for NUTAG_SUBSTATE().
 
#define NUTAG_SUB_EXPIRES(x)
 Default expiration time of subscriptions. More...
 
#define NUTAG_SUB_EXPIRES_REF(x)
 Reference tag for NUTAG_SUB_EXPIRES().
 
#define NUTAG_NEWSUB(x)
 Send unsolicited NOTIFY request. More...
 
#define NUTAG_NEWSUB_REF(x)
 Reference tag for NUTAG_NEWSUB().
 
#define NUTAG_REFER_EXPIRES(x)
 Default lifetime for implicit subscriptions created by REFER. More...
 
#define NUTAG_REFER_EXPIRES_REF(x)
 Reference tag for NUTAG_REFER_EXPIRES().
 
#define NUTAG_REFER_WITH_ID(x)
 Always use id parameter with refer event. More...
 
#define NUTAG_REFER_WITH_ID_REF(x)
 Reference tag for NUTAG_REFER_WITH_ID().
 
#define NUTAG_MEDIA_FEATURES(x)
 Add media tags from our offer to Accept-Contact headers. More...
 
#define NUTAG_MEDIA_FEATURES_REF(x)
 Reference tag for NUTAG_MEDIA_FEATURES().
 
#define NUTAG_CALLEE_CAPS(x)
 Add methods parameter and media feature parameter to the Contact headers generated for REGISTER request. More...
 
#define NUTAG_CALLEE_CAPS_REF(x)
 Reference tag for NUTAG_CALLEE_CAPS().
 
#define NUTAG_PATH_ENABLE(x)
 If true, add "path" to Supported in REGISTER. More...
 
#define NUTAG_PATH_ENABLE_REF(x)
 Reference tag for NUTAG_PATH_ENABLE().
 
#define NUTAG_SERVICE_ROUTE_ENABLE(x)
 Use route taken from the Service-Route header in the 200 class response to REGISTER. More...
 
#define NUTAG_SERVICE_ROUTE_ENABLE_REF(x)
 Reference tag for NUTAG_SERVICE_ROUTE_ENABLE().
 
#define NUTAG_MEDIA_ENABLE(x)
 Enable built-in media session handling. More...
 
#define NUTAG_MEDIA_ENABLE_REF(x)
 Reference tag for NUTAG_MEDIA_ENABLE().
 
#define NUTAG_OFFER_RECV(x)
 Indicate that SDP offer has been received. More...
 
#define NUTAG_OFFER_RECV_REF(x)
 Reference tag for NUTAG_OFFER_RECV().
 
#define NUTAG_ANSWER_RECV(x)
 Indicate that SDP answer has been received. More...
 
#define NUTAG_ANSWER_RECV_REF(x)
 Reference tag for NUTAG_ANSWER_RECV().
 
#define NUTAG_OFFER_SENT(x)
 Indicate that SDP offer has been sent. More...
 
#define NUTAG_OFFER_SENT_REF(x)
 Reference tag for NUTAG_OFFER_SENT().
 
#define NUTAG_ANSWER_SENT(x)
 Indicate that SDP answer has been sent. More...
 
#define NUTAG_ANSWER_SENT_REF(x)
 Reference tag for NUTAG_ANSWER_SENT().
 
#define NUTAG_DETECT_NETWORK_UPDATES(x)
 Enable detection of local IP address updates. More...
 
#define NUTAG_DETECT_NETWORK_UPDATES_REF(x)
 Reference tag for NUTAG_DETECT_NETWORK_UPDATES().
 
#define NUTAG_SHUTDOWN_EVENTS(x)
 Allow passing of normal events when stack is being shut down. More...
 
#define NUTAG_SHUTDOWN_EVENTS_REF(x)
 Reference tag for NUTAG_SHUTDOWN_EVENTS().
 
#define NUTAG_DEFERRABLE_TIMERS(x)
 Use deferrable timers in NUA. More...
 
#define NUTAG_DEFERRABLE_TIMERS_REF(x)
 Reference tag for NUTAG_DEFERRABLE_TIMERS().
 

Typedefs

typedef struct nua_s nua_t
 NUA agent. More...
 
typedef struct nua_handle_s nua_handle_t
 NUA transaction handle. More...
 

Enumerations

Functions

char const * nua_callstate_name (enum nua_callstate state)
 Get name for NUA call state. 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...
 

Variables

tag_type_t nua_tag_list []
 List of all NUA tags. More...
 

Detailed Description

Tags for Sofia-SIP User Agent Library.

Author
Pekka Pessi Pekka.nosp@m..Pes.nosp@m.si@no.nosp@m.kia..nosp@m.com
Martti Mela Martt.nosp@m.i.Me.nosp@m.la@no.nosp@m.kia..nosp@m.com
Date
Created: Mon Feb 19 18:54:26 EET 2001 ppessi

Macro Definition Documentation

#define NUA_TAG_H

Defined when <sofia-sip/nua_tag.h> has been included.

#define NUTAG_ACCEPT_MULTIPART (   x)

Enable multipart processing for received messages.

If an incoming request or response contains multipart body, it is parsed and can be accessed from sip_multipart field.

Used with
nua_create(), nua_handle(), nua_set_hparams(), nua_get_params(), nua_get_hparams(), nua_register(), nua_unregister(), nua_options(), nua_invite(), nua_ack(), nua_cancel(), nua_bye(), nua_prack(), nua_update(), nua_info(), nua_message(), nua_publish(), nua_unpublish(), nua_notifier(), nua_subscribe(), nua_unsubscribe(), nua_notify(), nua_refer(), nua_method(), nua_respond(), nua_authenticate().
Parameter type
int (boolean)
Values
  • 0 (false) - do not interpret multipart bodies
  • 1 (true) - try to parse message body in multipart format

Corresponding tag taking reference parameter is NUTAG_ACCEPT_MULTIPART_REF()

Since
Not yet released
#define NUTAG_ACCEPT_MULTIPART_REF (   x)

Reference tag for NUTAG_ACCEPT_MULTIPART().

Since
Not yet released
#define NUTAG_ALLOW (   x)

Allow a method (or methods).

This tag is used to add a new method to the already existing set of allowed methods. If you want to ignore the existing set of allowed methods, use SIPTAG_ALLOW_STR() or SIPTAG_ALLOW().

The set of allowed methods is added to the Allow header in the response or request messages. For incoming request, an error response 405 Method Not Allowed is automatically returned if the incoming method is not included in the set.

Used with
nua_set_params()
nua_set_hparams()
any handle-specific nua call
Parameter type
char const *
Values
Valid method name, or comma-separated list of them.

Corresponding tag taking reference parameter is NUTAG_ALLOW_REF().

#define NUTAG_ALLOW_EVENTS (   x)

Allow an event or events.

This tag is used to add a new event to the already existing set of allowed events. If you want to ignore the existing set of allowed events, set the allowed event set with SIPTAG_ALLOW_EVENTS_STR() or SIPTAG_ALLOW_EVENTS().

The set of allowed methods is added to the Allow-Events header in the response to the SUBSCRIBE or PUBLISH requests. For incoming SUBSCRIBE or PUBLISH request, an error response 489 Bad Event is automatically returned if the incoming method is not included in the set.

Used with
nua_set_params()
nua_set_hparams()
any handle-specific nua call
Parameter type
char const *
Values
Valid event name, or comma-separated list of them.
See also
Allow-Events, RFC 3265, RFC 3903, nua_i_subscribe, nua_i_publish, nua_i_refer, nua_notify(), nua_refer(), nua_subscribe(), nua_publish(), SIPTAG_ALLOW_EVENTS(), SIPTAG_ALLOW_EVENTS_STR(), NUTAG_APPL_EVENT()
Since
New in 1.12.4.

Corresponding tag taking reference parameter is NUTAG_ALLOW_EVENTS_REF().

#define NUTAG_ANSWER_RECV (   x)

Indicate that SDP answer has been received.

Used with
nua_i_state
Parameter type
int (boolean: nonzero is true, zero is false)

Corresponding tag taking reference parameter is NUTAG_ANSWER_RECV_REF().

#define NUTAG_ANSWER_SENT (   x)

Indicate that SDP answer has been sent.

Used with
nua_i_state
Parameter type
int (boolean: nonzero is true, zero is false)

Corresponding tag taking reference parameter is NUTAG_ANSWER_SENT_REF().

#define NUTAG_ANY ( )

Filter tag matching any nua tag.

#define NUTAG_APPL_EVENT (   x)

List events which the application handles always.

When nua stack receives a SUBSCRIBE request for an already existing subscription, it can either automatically refresh the subscription or, if the event name is listed in NUTAG_APPL_EVENT() list, it is passed to application, pass the SUBSCRIBE request to application.

The list of application events is cleared with NUTAG_APPL_EVENT(NULL).

Used with
nua_set_params()
nua_set_hparams()
any handle-specific nua call
Parameter type
char const *
Values
Valid event name, or comma-separated list of them.
See also
Allow-Events, RFC 3265, RFC 3903, nua_i_subscribe, nua_i_publish, nua_i_refer, nua_notify(), nua_refer(), nua_subscribe(), nua_publish(), NUTAG_ALLOW_EVENTS(),
Since
Not yet released

Corresponding tag taking reference parameter is NUTAG_APPL_EVENT_REF().

#define NUTAG_APPL_METHOD (   x)

Indicate that a method (or methods) are handled by application.

This tag is used to add a new method to the already existing set of methods handled by application, or clear the set. If you want to determine the set explicitly, include NUTAG_APPL_METHOD() twice, first with NULL and then with your supported set.

The default set of application methods now include INVITE, REGISTER, PUBLISH and SUBSCRIBE.

If the request method is in the set of methods handled by application, the nua stack does not automatically respond to the incoming request nor it will automatically send such a request. Note if the application adds the PRACK and UPDATE requests to the set of application methods it must also take care for sending the PRACK and UPDATE requests during the call setup when necessary.

Used with
nua_set_params()
nua_set_hparams()
any handle-specific nua call
Parameter type
char const *
Values
Valid method name, or comma-separated list of them.

Corresponding tag taking reference parameter is NUTAG_APPL_METHOD_REF().

Since
Working since 1.12.5. Handling of client-side PRACK and UPDATE was fixed in 1.12.6.
#define NUTAG_AUTH (   x)

Authentication data ("scheme" "realm" "user" "password")

Used with
nua_authenticate()
Parameter type
char const *
Values
NULL terminated string of format:
basic digest scheme:"realm":user:password
NOTE the double quotes around realm! For example:
1 Digest:"nokia proxy":xyz:secret

Corresponding tag taking reference parameter is NUTAG_AUTH_REF().

#define NUTAG_AUTH_CACHE (   x)

Authentication caching policy.

Used with
nua_set_params(), nua_set_hparams()
nua_get_params(), nua_get_hparams()
nua_method(), nua_respond(), nua_invite(), nua_ack(), nua_cancel(), nua_prack(), nua_update(), nua_info(), nua_bye(), nua_options(), nua_message(), nua_register(), nua_unregister(), nua_publish(), nua_refer(), nua_subscribe(), nua_unsubscribe(), nua_notify(), nua_notifier()
Parameter type
enum nua_auth_cache
Values
  • nua_auth_cache_dialog (0) - include credentials within dialog
  • nua_auth_cache_challenged (1) - include credentials only when challenged

Corresponding tag taking reference parameter is NUTAG_AUTH_CACHE_REF().

Since
New in 1.12.6.
#define NUTAG_AUTHTIME (   x)

Lifetime of authentication data in seconds.

Used with
Currently not processed by NUA
Parameter type
unsigned int
Values
  • 0 (zero) - Use authentication data only for this handle
  • nonzero - Lifetime of authentication data in seconds

Corresponding tag taking reference parameter is NUTAG_AUTHTIME_REF().

#define NUTAG_AUTO100 (   x)

Generate automatically 100 Trying responses.

If this parameter is true, the server will automatically generate a "100 Trying" response to the incoming INVITE request (and other requests containing Timestamp header).

Used with
nua_create(), nua_set_params(), nua_set_hparams(),
nua_get_params(), nua_get_hparams(),
nua_invite(), nua_prack(), nua_ack(), nua_update(), nua_respond(),
nua_info(), nua_cancel(), nua_bye(),
nua_register(), nua_unregister(), nua_publish(), nua_unpublish(),
nua_subscribe(), nua_unsubscribe(), nua_refer(), nua_notify(),
nua_options(), nua_message(), nua_method()
Parameter type
int (boolean: nonzero is true, zero is false)
Values
  • 0 (false) - let application generate 100 Trying
  • 1 (true) - automatically generate 100 Trying response

Default value is NUTAG_AUTO100(1).

Corresponding tag taking reference parameter is NUTAG_AUTO100_REF().

Since
Not yet released
See also
NTATAG_EXTRA_100()
#define NUTAG_AUTO302 (   x)

Recurse automatically on 302 response.

If this parameter is true, a client recurses automatically upon receiving a 302 response. The request is resent with the request-URI from the Contact header in the 302 response.

Used with
nua_create(), nua_set_params(), nua_set_hparams(),
nua_get_params(), nua_get_hparams(),
nua_invite(), nua_prack(), nua_ack(), nua_update(), nua_respond(),
nua_info(), nua_cancel(), nua_bye(),
nua_register(), nua_unregister(), nua_publish(), nua_unpublish(),
nua_subscribe(), nua_unsubscribe(), nua_refer(), nua_notify(),
nua_options(), nua_message(), nua_method()
Parameter type
int (boolean: nonzero is true, zero is false)
Values
  • 0 (false) - process 302 as an ordinary final response
  • 1 (true) - resend request with URI received in 302 response

Default value is NUTAG_AUTO302(1).

Corresponding tag taking reference parameter is NUTAG_AUTO302_REF().

Since
New in 1.12.11
#define NUTAG_AUTO305 (   x)

Recurse automatically on 305 response.

If this parameter is true, a client recurses automatically upon receiving a 305 response. The request is resent via the proxy specified by the Contact header in the 305 response. The proxy URI is included in the Route header of the request.

Note that the NUTAG_PROXY() takes a precedence over the proxy in 305, and the NUTAG_PROXY() is responsible of actually routing the request through the 305 proxy.

Used with
nua_create(), nua_set_params(), nua_set_hparams(),
nua_get_params(), nua_get_hparams(),
nua_invite(), nua_prack(), nua_ack(), nua_update(), nua_respond(),
nua_info(), nua_cancel(), nua_bye(),
nua_register(), nua_unregister(), nua_publish(), nua_unpublish(),
nua_subscribe(), nua_unsubscribe(), nua_refer(), nua_notify(),
nua_options(), nua_message(), nua_method()
Parameter type
int (boolean: nonzero is true, zero is false)
Values
  • 0 (false) - process 305 as an ordinary final response
  • 1 (true) - resend request via proxy received in 305 response

Default value is NUTAG_AUTO305(1).

Corresponding tag taking reference parameter is NUTAG_AUTO305_REF().

Since
New in 1.12.11
#define NUTAG_AUTOACK (   x)

ACK automatically.

If this parameter is true, ACK is sent automatically after receiving 2XX series response to INVITE. Note that ACK is always sent automatically by lower layers of the stack after receiving an error response 3XX, 4XX, 5XX or 6XX.

Used with
nua_set_params(), nua_set_hparams(),
nua_get_params(), nua_get_hparams(),
nua_invite(), nua_ack(), nua_respond(), nua_update()
nua_respond()
Parameter type
int (boolean: nonzero is true, zero is false)
Values
  • 0 (false) - No automatic sending of ACK
  • 1 (true) - ACK sent automatically

Default value is NUTAG_AUTOACK(1).

Auto ACK with Re-INVITE requests
By default, NUA tries to auto-ACK the final response to re-INVITE used to refresh the session when the media is enabled. Set NUTAG_AUTOACK(0) on the call handle (e.g., include the tag with nua_invite() or nua_respond()) in order to disable the auto ACK with re-INVITE.

Corresponding tag taking reference parameter is NUTAG_AUTOACK_REF().

#define NUTAG_AUTOALERT (   x)

Send alerting (180 Ringing) automatically (instead of 100 Trying).

If the early media has been enabled with NUTAG_EARLY_MEDIA(1)