sofia-sip/nua_tag.h File Reference

Detailed Description

Tags for Sofia-SIP User Agent Library.

Author:: Pekka Pessi <Pekka.Pessi@nokia-email.address.hidden>
Martti Mela <Martti.Mela@nokia-email.address.hidden>

Date:: Created: Mon Feb 19 18:54:26 EET 2001 ppessi

#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:


Defines
#define	NUTAG_ANY()
	Filter tag matching any nua tag.
#define	NUTAG_URL(x)
	URL address from application to NUA.
#define	NUTAG_WITH(x)
	Specify request to respond to.
#define	NUTAG_WITH_THIS(nua)
	Specify request to respond to.
#define	NUTAG_WITH_SAVED(e)
	Specify request to respond to.
#define	NUTAG_DIALOG(b)
	An (extension) method is used to create dialog or refresh target.
#define	NUTAG_METHOD(x)
	Extension method name.
#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.
#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.
#define	NUTAG_USE_DIALOG_REF(x)
	Reference tag for NUTAG_USE_DIALOG().
#define	NUTAG_RETRY_COUNT(x)
	Set request retry count.
#define	NUTAG_RETRY_COUNT_REF(x)
	Reference tag for NUTAG_RETRY_COUNT().
#define	NUTAG_SOA_NAME(x)
	Name for SDP Offer-Answer session object.
#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.
#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.
#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.
#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.
#define	NUTAG_INCLUDE_EXTRA_SDP_REF(x)
	Reference tag for NUTAG_INCLUDE_EXTRA_SDP().
#define	NUTAG_INVITE_TIMER(x)
	Timer for outstanding INVITE in seconds.
#define	NUTAG_INVITE_TIMER_REF(x)
	Reference tag for NUTAG_INVITE_TIMER().
#define	NUTAG_SESSION_TIMER(x)
	Default session timer in seconds.
#define	NUTAG_SESSION_TIMER_REF(x)
	Reference tag for NUTAG_SESSION_TIMER().
#define	NUTAG_MIN_SE(x)
	Minimum acceptable refresh interval for session.
#define	NUTAG_MIN_SE_REF(x)
	Reference tag for NUTAG_MIN_SE().
#define	NUTAG_SESSION_REFRESHER(x)
	Specify the preferred refresher.
#define	NUTAG_SESSION_REFRESHER_REF(x)
	Reference tag for NUTAG_SESSION_REFRESHER().
#define	NUTAG_UPDATE_REFRESH(x)
	Use UPDATE as refresh method.
#define	NUTAG_UPDATE_REFRESH_REF(x)
	Reference tag for NUTAG_UPDATE_REFRESH().
#define	NUTAG_AUTOALERT(x)
	Send alerting (180 Ringing) automatically.
#define	NUTAG_AUTOALERT_REF(x)
	Reference tag for NUTAG_AUTOALERT().
#define	NUTAG_AUTOACK(x)
	ACK automatically.
#define	NUTAG_AUTOACK_REF(x)
	Reference tag for NUTAG_AUTOACK().
#define	NUTAG_AUTOANSWER(x)
	Answer (with 200 Ok) automatically to incoming call.
#define	NUTAG_AUTOANSWER_REF(x)
	Reference tag for NUTAG_AUTOANSWER().
#define	NUTAG_ENABLEINVITE(x)
	Enable incoming INVITE.
#define	NUTAG_ENABLEINVITE_REF(x)
	Reference tag for NUTAG_ENABLEINVITE().
#define	NUTAG_ENABLEMESSAGE(x)
	Enable incoming MESSAGE.
#define	NUTAG_ENABLEMESSAGE_REF(x)
	Reference tag for NUTAG_ENABLEMESSAGE().
#define	NUTAG_ENABLEMESSENGER(x)
	Enable incoming MESSAGE with To tag.
#define	NUTAG_ENABLEMESSENGER_REF(x)
	Reference tag for NUTAG_ENABLEMESSENGER().
#define	NUTAG_SMIME_ENABLE(x)
	Enable S/MIME.
#define	NUTAG_SMIME_ENABLE_REF(x)
	Reference tag for NUTAG_SMIME_ENABLE().
#define	NUTAG_SMIME_OPT(x)
	S/MIME Options.
#define	NUTAG_SMIME_OPT_REF(x)
	Reference tag for NUTAG_SMIME_OPT().
#define	NUTAG_SMIME_PROTECTION_MODE(x)
	S/MIME protection mode.
#define	NUTAG_SMIME_PROTECTION_MODE_REF(x)
	Reference tag for NUTAG_SMIME_PROTECTION_MODE().
#define	NUTAG_SMIME_MESSAGE_DIGEST(x)
	S/MIME digest algorithm.
#define	NUTAG_SMIME_MESSAGE_DIGEST_REF(x)
	Reference tag for NUTAG_SMIME_MESSAGE_DIGEST().
#define	NUTAG_SMIME_SIGNATURE(x)
	S/MIME signature algorithm.
#define	NUTAG_SMIME_SIGNATURE_REF(x)
	Reference tag for NUTAG_SMIME_SIGNATURE().
#define	NUTAG_SMIME_KEY_ENCRYPTION(x)
	S/MIME key encryption algorithm.
#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.
#define	NUTAG_SMIME_MESSAGE_ENCRYPTION_REF(x)
	Reference tag for NUTAG_SMIME_MESSAGE_ENCRYPTION().
#define	NUTAG_CERTIFICATE_DIR(x)
	X.500 certificate directory.
#define	NUTAG_CERTIFICATE_DIR_REF(x)
	Reference tag for NUTAG_CERTIFICATE_DIR().
#define	NUTAG_CERTIFICATE_PHRASE(x)
	Certificate phrase.
#define	NUTAG_CERTIFICATE_PHRASE_REF(x)
	Reference tag for NUTAG_CERTIFICATE_PHRASE().
#define	NUTAG_SIPS_URL(x)
	Local SIPS url.
#define	NUTAG_SIPS_URL_REF(x)
	Reference tag for NUTAG_SIPS_URL().
#define	NUTAG_PROXY(x)
	Outbound proxy URL.
#define	NUTAG_PROXY_REF(x)
	Reference tag for NUTAG_PROXY().
#define	NUTAG_INITIAL_ROUTE(x)
	Specify initial route set.
#define	NUTAG_INITIAL_ROUTE_REF(x)
	Reference tag for NUTAG_INITIAL_ROUTE().
#define	NUTAG_INITIAL_ROUTE_STR(x)
	Specify initial route set.
#define	NUTAG_INITIAL_ROUTE_STR_REF(x)
	Reference tag for NUTAG_INITIAL_ROUTE_STR().
#define	NUTAG_REGISTRAR(x)
	Registrar URL.
#define	NUTAG_REGISTRAR_REF(x)
	Reference tag for NUTAG_REGISTRAR().
#define	NUTAG_OUTBOUND(x)
	Outbound option string.
#define	NUTAG_OUTBOUND_REF(x)
	Reference tag for NUTAG_OUTBOUND().
#define	NUTAG_SIP_PARSER(x)
	Pointer to SIP parser structure.
#define	NUTAG_SIP_PARSER_REF(x)
	Reference tag for NUTAG_SIP_PARSER().
#define	NUTAG_AUTH(x)
	Authentication data ("scheme" "realm" "user" "password").
#define	NUTAG_AUTH_REF(x)
	Reference tag for NUTAG_AUTH().
#define	NUTAG_AUTH_CACHE(x)
	Authentication caching policy.
#define	NUTAG_AUTH_CACHE_REF(x)
	Reference tag for NUTAG_AUTH_CACHE().
#define	NUTAG_KEEPALIVE(x)
	Keepalive interval in milliseconds.
#define	NUTAG_KEEPALIVE_REF(x)
	Reference tag for NUTAG_KEEPALIVE().
#define	NUTAG_KEEPALIVE_STREAM(x)
	Transport-level keepalive interval for streams.
#define	NUTAG_KEEPALIVE_STREAM_REF(x)
	Reference tag for NUTAG_KEEPALIVE_STREAM().
#define	NUTAG_AUTHTIME(x)
	Lifetime of authentication data in seconds.
#define	NUTAG_AUTHTIME_REF(x)
	Reference tag for NUTAG_AUTHTIME().
#define	NUTAG_M_DISPLAY(x)
	Display name for Contact.
#define	NUTAG_M_DISPLAY_REF(x)
	Reference tag for NUTAG_M_DISPLAY().
#define	NUTAG_M_USERNAME(x)
	Username prefix for Contact.
#define	NUTAG_M_USERNAME_REF(x)
	Reference tag for NUTAG_M_USERNAME().
#define	NUTAG_M_PARAMS(x)
	URL parameters for Contact.
#define	NUTAG_M_PARAMS_REF(x)
	Reference tag for NUTAG_M_PARAMS().
#define	NUTAG_M_FEATURES(x)
	Header parameters for Contact used in registration.
#define	NUTAG_M_FEATURES_REF(x)
	Reference tag for NUTAG_M_FEATURES().
#define	NUTAG_EVENT(x)
	NUA event.
#define	NUTAG_EVENT_REF(x)
	Reference tag for NUTAG_EVENT().
#define	NUTAG_STATUS(x)
	Response status code.
#define	NUTAG_STATUS_REF(x)
	Reference tag for NUTAG_STATUS().
#define	NUTAG_PHRASE(x)
	Response phrase.
#define	NUTAG_PHRASE_REF(x)
	Reference tag for NUTAG_PHRASE().
#define	NUTAG_HANDLE(x)
	NUA Handle.
#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).
#define	NUTAG_IDENTITY_REF(x)
	Reference tag for NUTAG_IDENTITY().
#define	NUTAG_INSTANCE(x)
	Intance identifier.
#define	NUTAG_INSTANCE_REF(x)
	Reference tag for NUTAG_INSTANCE().
#define	NUTAG_NOTIFY_REFER(x)
	Refer reply handle (used with refer).
#define	NUTAG_NOTIFY_REFER_REF(x)
	Reference tag for NUTAG_NOTIFY_REFER().
#define	NUTAG_REFER_EVENT(x)
	Event used with automatic refer notifications.
#define	NUTAG_REFER_EVENT_REF(x)
	Reference tag for NUTAG_REFER_EVENT().
#define	NUTAG_REFER_PAUSE(x)
	Invite pauses referrer's handle.
#define	NUTAG_REFER_PAUSE_REF(x)
	Reference tag for NUTAG_REFER_PAUSE().
#define	NUTAG_USER_AGENT(x)
	User-Agent string.
#define	NUTAG_USER_AGENT_REF(x)
	Reference tag for NUTAG_USER_AGENT().
#define	NUTAG_ALLOW(x)
	Allow a method (or methods).
#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.
#define	NUTAG_APPL_METHOD_REF(x)
	Reference tag for NUTAG_APPL_METHOD().
#define	NUTAG_SUPPORTED(x)
	Support a feature.
#define	NUTAG_SUPPORTED_REF(x)
	Reference tag for NUTAG_SUPPORTED().
#define	NUTAG_ALLOW_EVENTS(x)
	Allow an event or events.
#define	NUTAG_ALLOW_EVENTS_REF(x)
	Reference tag for NUTAG_ALLOW_EVENTS().
#define	NUTAG_CALLSTATE(x)
	Call state.
#define	NUTAG_CALLSTATE_REF(x)
	Reference tag for NUTAG_CALLSTATE().
#define	NUTAG_SUBSTATE(x)
	Subscription state.
#define	NUTAG_SUBSTATE_REF(x)
	Reference tag for NUTAG_SUBSTATE().
#define	NUTAG_SUB_EXPIRES(x)
	Default expiration time of subscriptions.
#define	NUTAG_SUB_EXPIRES_REF(x)
	Reference tag for NUTAG_SUB_EXPIRES().
#define	NUTAG_NEWSUB(x)
	Send unsolicited NOTIFY request.
#define	NUTAG_NEWSUB_REF(x)
	Reference tag for NUTAG_NEWSUB().
#define	NUTAG_REFER_EXPIRES(x)
	Default lifetime for implicit subscriptions created by REFER.
#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.
#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.
#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.
#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.
#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.
#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.
#define	NUTAG_MEDIA_ENABLE_REF(x)
	Reference tag for NUTAG_MEDIA_ENABLE().
#define	NUTAG_OFFER_RECV(x)
	Indicate that SDP offer has been received.
#define	NUTAG_OFFER_RECV_REF(x)
	Reference tag for NUTAG_OFFER_RECV().
#define	NUTAG_ANSWER_RECV(x)
	Indicate that SDP answer has been received.
#define	NUTAG_ANSWER_RECV_REF(x)
	Reference tag for NUTAG_ANSWER_RECV().
#define	NUTAG_OFFER_SENT(x)
	Indicate that SDP offer has been sent.
#define	NUTAG_OFFER_SENT_REF(x)
	Reference tag for NUTAG_OFFER_SENT().
#define	NUTAG_ANSWER_SENT(x)
	Indicate that SDP answer has been sent.
#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.
#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.
#define	NUTAG_SHUTDOWN_EVENTS_REF(x)
	Reference tag for NUTAG_SHUTDOWN_EVENTS().
Typedefs
typedef nua_s	nua_t
	NUA agent.
typedef nua_handle_s	nua_handle_t
	NUA transaction handle.
Enumerations
enum	nua_session_refresher { nua_no_refresher, nua_local_refresher, nua_remote_refresher, nua_any_refresher }
	Enumeration type of NUTAG_SESSION_REFRESHER(). More...
enum	nua_auth_cache { nua_auth_cache_dialog, nua_auth_cache_challenged }
	Authentication caching policy. More...
enum	nua_callstate { nua_callstate_init, nua_callstate_authenticating, nua_callstate_calling, nua_callstate_proceeding, nua_callstate_completing, nua_callstate_received, nua_callstate_early, nua_callstate_completed, nua_callstate_ready, nua_callstate_terminating, nua_callstate_terminated }
	The states for SIP session established with INVITE. More...
enum	nua_substate { nua_substate_extended, nua_substate_embryonic, nua_substate_pending, nua_substate_active, nua_substate_terminated }
	Parameter type of NUTAG_SUBSTATE(). More...
Functions
char const *	nua_callstate_name (enum nua_callstate state)
	Get name for NUA call state.
char const *	nua_substate_name (enum nua_substate substate)
	Return name of subscription state.
enum nua_substate	nua_substate_make (char const *sip_substate)
	Convert string to enum nua_substate.
Variables
tag_type_t	nua_tag_list []
	List of all NUA tags.

Define Documentation

#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_subscribe(), nua_publish(), SIPTAG_ALLOW_EVENTS(), SIPTAG_ALLOW_EVENTS_STR()

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_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:

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 Use authentication data only for this handle
!=0 Lifetime in seconds

Todo:
Corresponding tag taking reference parameter is NUTAG_AUTHTIME_REF().

#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

Values
0 No automatic sending of ACK
!=0 ACK sent automatically
Default value is NUTAG_AUTOACK(1).
Corresponding tag taking reference parameter is NUTAG_AUTOACK_REF().

#define NUTAG_AUTOALERT ( x )

Send alerting (180 Ringing) automatically.

Used with
nua_set_params()
nua_get_params()

Parameter type
int

Values
0 No automatic sending of "180 Ringing"
!=0 "180 Ringing" sent automatically
Corresponding tag taking reference parameter is NUTAG_AUTOALERT_REF().

#define NUTAG_AUTOANSWER ( x )

Answer (with 200 Ok) automatically to incoming call.

Used with
nua_set_params(), nua_set_hparams()
nua_get_params(), nua_get_hparams()
nua_invite()
nua_respond()

Parameter type
int (boolean)

Values

0 (false) - No automatic sending of "200 Ok"
1 (true) - "200 Ok" sent automatically

Corresponding tag taking reference parameter is NUTAG_AUTOANSWER_REF().

Note:
Requires that soa is enabled with NUTAG_MEDIA_ENABLE(1).

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

Bug:
If the re-INVITE modifies the session (e.g., SDP contains offer that adds video stream to the session), NUA auto-answers it if NUTAG_AUTOANSWER(0) has not been set on the handle. It accepts or rejects media based on the existing user SDP (set with SOATAG_USER_SDP(), for example). It should auto-answer only session refresh request and let application decide how to handle requests to modify the session.

See also:
NUTAG_MEDIA_ENABLE(), NUTAG_AUTOALERT(), NUTAG_AUTOACK().

#define NUTAG_CALLEE_CAPS ( x )

Add methods parameter and media feature parameter to the Contact headers generated for REGISTER request.

Used with

nua_create(), nua_set_params(), nua_get_params()
nua_handle(), nua_set_hparams(), nua_get_hparams()
nua_register()

Parameter type
int

Values

0 (false) - Do not include methods and media feature parameters
1 (true) - Include media tags in Contact

Corresponding tag taking reference parameter is NUTAG_MEDIA_FEATURES_REF().

See also:
nua_register(), Contact, NUTAG_M_FEATURES(), RFC 3840, RFC 3841, SOATAG_USER_SDP(), NUTAG_MEDIA_FEATURES()

#define NUTAG_CALLSTATE ( x )

Call state.

Used with
nua_i_state

Parameter type
int

Values

nua_callstate_init - Initial state
nua_callstate_authenticating - 401/407 received
nua_callstate_calling - INVITE sent
nua_callstate_proceeding - 18X received
nua_callstate_completing - 2XX received
nua_callstate_received - INVITE received (and 100 Trying sent)
nua_callstate_early - 18X sent
nua_callstate_completed - 2XX sent
nua_callstate_ready - 2XX and ACK received/sent
nua_callstate_terminating - BYE sent
nua_callstate_terminated - BYE complete

Corresponding tag taking reference parameter is NUTAG_CALLSTATE_REF().

#define NUTAG_CERTIFICATE_DIR ( x )

X.500 certificate directory.

Used with
nua_create()

Parameter type
char const *

Values
NULL terminated pathname of directory containing agent.pem and cafile.pem files.
Corresponding tag taking reference parameter is NUTAG_CERTIFICATE_DIR_REF().

#define NUTAG_CERTIFICATE_PHRASE ( x )

Certificate phrase.

Used with
Currently not processed by NUA

Parameter type
char const *

Values
Corresponding tag taking reference parameter is NUTAG_CERTIFICATE_PHRASE_REF().

#define NUTAG_DETECT_NETWORK_UPDATES ( x )

Enable detection of local IP address updates.

Used with
nua_create()
nua_set_params()
nua_get_params()

Parameter type
int (enum nua_nw_detector_e aka nua_nw_detector_t)

See also:
nua_i_network_changed, nua_nw_detector_t
Corresponding tag taking reference parameter is NUTAG_DETECT_NETWORK_UPDATES_REF().

Since:
New in 1.12.2.

#define NUTAG_DIALOG ( b )

An (extension) method is used to create dialog or refresh target.

Used with
nua_method()

Parameter type
unsigned int (0, 1, 2)

Values

0 if dialog target is not refreshed
1 if dialog target is refreshed
> 1 if dialog is to be created

Since:
New in 1.12.6.

See also:
nua_method(), nua_i_method

#define NUTAG_EARLY_ANSWER ( x )

Establish early media session by including SDP answer in 1XX response.

Used with
nua_respond(), nua_set_params(), nua_set_hparams()

Parameter type
int (boolean)

Values
0 False
!=0 True
Corresponding tag taking reference parameter is NUTAG_EARLY_ANSWER_REF().

Note:
Requires that soa is enabled with NUTAG_MEDIA_ENABLE(1).

See also:
NUTAG_EARLY_MEDIA(), NUTAG_AUTOALERT(), NUTAG_MEDIA_ENABLE()

Since:
New in 1.12.2.

#define NUTAG_EARLY_MEDIA ( x )

Establish early media session using 100rel, 183 responses and PRACK.

U

sofia-sip/nua_tag.h File Reference

Detailed Description

Defines

Typedefs

Enumerations

Functions

Variables

Define Documentation