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>
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_ADDRESS(x)
 Address as a string.
#define NUTAG_RETRY_COUNT(x)
 Set request retry count.
#define NUTAG_MAX_SUBSCRIPTIONS(x)
 Set maximum number of simultaneous subscribers per single event server.
#define NUTAG_UICC(x)
 Intentionally undocumented.
#define NUTAG_USE_DIALOG(x)
 Ask NUA to create dialog for this handle.
#define NUTAG_SOA_NAME(x)
 Name for SDP Offer-Answer session object.
#define NUTAG_EARLY_MEDIA(x)
 Establish early media session using 183 responses and PRACK requests.
#define NUTAG_ONLY183_100REL(x)
 Respond only 183 with 100rel.
#define NUTAG_INVITE_TIMER(x)
 Timer for outstanding INVITE in seconds.
#define NUTAG_SESSION_TIMER(x)
 Default session timer in seconds.
#define NUTAG_MIN_SE(x)
 Minimum acceptable refresh interval for session.
#define NUTAG_SESSION_REFRESHER(x)
 Specify preferred refresher.
#define NUTAG_UPDATE_REFRESH(x)
 Use UPDATE as refresh method.
#define NUTAG_AUTOALERT(x)
 Send alerting (180 Ringing) automatically.
#define NUTAG_AUTOACK(x)
 ACK automatically.
#define NUTAG_AUTOANSWER(x)
 Answer (200 Ok) automatically to incoming call.
#define NUTAG_ENABLEINVITE(x)
 Enable incoming INVITE.
#define NUTAG_ENABLEMESSAGE(x)
 Enable incoming MESSAGE.
#define NUTAG_ENABLEMESSENGER(x)
 Enable incoming MESSAGE with To tag.
#define NUTAG_SMIME_ENABLE(x)
 Enable S/MIME.
#define NUTAG_SMIME_OPT(x)
 S/MIME Options.
#define NUTAG_SMIME_PROTECTION_MODE(x)
 S/MIME protection mode.
#define NUTAG_SMIME_MESSAGE_DIGEST(x)
 S/MIME digest algorithm.
#define NUTAG_SMIME_SIGNATURE(x)
 S/MIME signature algorithm.
#define NUTAG_SMIME_KEY_ENCRYPTION(x)
 S/MIME key encryption algorithm.
#define NUTAG_SMIME_MESSAGE_ENCRYPTION(x)
 S/MIME message encryption algorithm.
#define NUTAG_CERTIFICATE_DIR(x)
 x.500 certificate directory
#define NUTAG_CERTIFICATE_PHRASE(x)
 Certificate phrase.
#define NUTAG_SIPS_URL(x)
 Local SIPS url.
#define NUTAG_PROXY(x)
 Outbound proxy URL.
#define NUTAG_REGISTRAR(x)
 Registrar URL.
#define NUTAG_OUTBOUND(x)
 Outbound option string.
#define NUTAG_SIP_PARSER(x)
 Pointer to SIP parser structure.
#define NUTAG_AUTH(x)
 Authentication data ("scheme" "realm" "user" "password").
#define NUTAG_KEEPALIVE(x)
 Keepalive interval in milliseconds.
#define NUTAG_KEEPALIVE_STREAM(x)
 Transport-level keepalive interval for streams.
#define NUTAG_AUTHTIME(x)
 Lifetime of authentication data in seconds.
#define NUTAG_EVENT(x)
 Events.
#define NUTAG_STATUS(x)
 Response status code.
#define NUTAG_PHRASE(x)
 Response phrase.
#define NUTAG_HANDLE(x)
 NUA Handle.
#define NUTAG_IDENTITY(x)
 Registration handle (used with requests and nua_respond()).
#define NUTAG_INSTANCE(x)
 Intance identifier.
#define NUTAG_NOTIFY_REFER(x)
 Refer reply handle (used with refer).
#define NUTAG_REFER_EVENT(x)
 Event used with automatic refer notifications.
#define NUTAG_REFER_PAUSE(x)
 Invite pauses referrer's handle.
#define NUTAG_USER_AGENT(x)
 User-Agent string.
#define NUTAG_ALLOW(x)
 Allow a method (or methods).
#define NUTAG_CALLSTATE(x)
 Call state.
#define NUTAG_SUBSTATE(x)
 Subscription state.
#define NUTAG_REFER_EXPIRES(x)
 Default lifetime for implicit subscriptions created by REFER.
#define NUTAG_MEDIA_FEATURES(x)
 Add media tags from our offer to Accept-Contact headers.
#define NUTAG_CALLEE_CAPS(x)
 Add methods and media tags to Contact headers.
#define NUTAG_PATH_ENABLE(x)
 If true, add "path" to Supported in REGISTER.
#define NUTAG_SERVICE_ROUTE_ENABLE(x)
 Use route from Service-Route header in response to REGISTER.
#define NUTAG_MEDIA_ENABLE(x)
 Enable local media (MSS).
#define NUTAG_OFFER_RECV(x)
 Indicate that SDP offer has been received.
#define NUTAG_ANSWER_RECV(x)
 Indicate that SDP answer has been received.
#define NUTAG_OFFER_SENT(x)
 Indicate that SDP offer has been sent.
#define NUTAG_ANSWER_SENT(x)
 Indicate that SDP answer has been sent.

Typedefs

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

Enumerations

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
}

Functions

SOFIAPUBFUN char const * nua_callstate_name (enum nua_callstate state)
 Get name for NUA call state.

Variables

SOFIAPUBVAR tag_type_t nua_tag_list []
 List of all NUA tags.

Define Documentation

#define NUTAG_ADDRESS (  ) 

Address as a string.

Used with
Parameter type
char const *
Values
String in form "name <url>"
Corresponding tag taking reference parameter is NUTAG_ADDRESS_REF()

#define NUTAG_ALLOW (  ) 

Allow a method (or methods).

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_ANSWER_RECV (  ) 

Indicate that SDP answer has been received.

Used with
nua_i_state
Parameter type
boolean
Corresponding tag taking reference parameter is NUTAG_ANSWER_RECV_REF()

#define NUTAG_ANSWER_SENT (  ) 

Indicate that SDP answer has been sent.

Used with
nua_i_state
Parameter type
boolean
Corresponding tag taking reference parameter is NUTAG_ANSWER_SENT_REF()

#define NUTAG_AUTH (  ) 

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_AUTHTIME (  ) 

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
Corresponding tag taking reference parameter is NUTAG_AUTHTIME_REF()

#define NUTAG_AUTOACK (  ) 

ACK automatically.

Used with
nua_set_params()
nua_get_params()
Parameter type
int
Values
0 No automatic sending of ACK
!=0 ACK sent automatically
Corresponding tag taking reference parameter is NUTAG_AUTOACK_REF()

#define NUTAG_AUTOALERT (  ) 

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 (  ) 

Answer (200 Ok) automatically to incoming call.

Used with
nua_set_params()
nua_get_params()
Parameter type
int
Values
0 No automatic sending of "200 Ok"
!=0 "200 Ok" sent automatically
Corresponding tag taking reference parameter is NUTAG_AUTOANSWER_REF()

#define NUTAG_CALLSTATE (  ) 

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_received - INVITE received
  • nua_callstate_early - 18X sent (w/SDP)
  • nua_callstate_ready - 2XX received or 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.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 (  ) 

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_EARLY_MEDIA (  ) 

Establish early media session using 183 responses and PRACK requests.

Used with
nua_set_params()
nua_get_params()
Parameter type
int
Values
0 False
!=0 True
Corresponding tag taking reference parameter is NUTAG_EARLY_MEDIA_REF()

#define NUTAG_ENABLEINVITE (  ) 

Enable incoming INVITE.

Used with
nua_set_params()
nua_get_params()
Parameter type
int
Values
0 Incoming INVITE not enabled. NUA answers 403 Forbidden
!=0 Incoming INVITE enabled
Corresponding tag taking reference parameter is NUTAG_ENABLEINVITE_REF()

#define NUTAG_ENABLEMESSAGE (  ) 

Enable incoming MESSAGE.

Used with
nua_set_params()
nua_get_params()
Parameter type
int
Values
0 Incoming MESSAGE not enabled. NUA answers 403 Forbidden
!=0 Incoming MESSAGE enabled
Corresponding tag taking reference parameter is NUTAG_ENABLEMESSAGE_REF()

#define NUTAG_ENABLEMESSENGER (  ) 

Enable incoming MESSAGE with To tag.

Set this parameter if you want to chat with Windows Messenger.

Used with
nua_set_params()
nua_get_params()
Parameter type
int
Values
0 False
!=0 True
Corresponding tag taking reference parameter is NUTAG_ENABLEMESSENGER_REF()

#define NUTAG_EVENT (  ) 

Events.

Used with
Currently not processed by NUA
Parameter type
void *
Values
Corresponding tag taking reference parameter is NUTAG_EVENT_REF()

#define NUTAG_HANDLE (  ) 

NUA Handle.

Used with
Currently not processed by NUA
Parameter type
nua_handle_t *
Values
Corresponding tag taking reference parameter is NUTAG_HANDLE_REF()

#define NUTAG_IDENTITY (  ) 

Registration handle (used with requests and nua_respond()).

When a new request is made or new call is responded, a new identity can be selected with NUTAG_IDENTITY(). The identity comprises of From header, initial route set, local contact header and media tags associated with it, soa handle and so on. User can make multiple registrations using multiple identities.

Used with
nua_invite()
Parameter type
nua_handle_t *
Values
Corresponding tag taking reference parameter is NUTAG_IDENTITY_REF()

#define NUTAG_INSTANCE (  ) 

Intance identifier.

Used with
nua_create(), nua_set_params(), nua_get_params(), nua_register()
Parameter type
char const *
Value
urn:uuid string.
Corresponding tag taking reference parameter is NUTAG_INSTANCE_REF()

#define NUTAG_INVITE_TIMER (  ) 

Timer for outstanding INVITE in seconds.

INVITE will be canceled if no answer is received before timer expires.

Used with
nua_invite()
nua_set_params()
nua_get_params()
Parameter type
int (enum nua_af)
Values
0 no timer
>0 timer in seconds
Corresponding tag taking reference parameter is NUTAG_INVITE_TIMER_REF()

#define NUTAG_KEEPALIVE (  ) 

Keepalive interval in milliseconds.

Used with
nua_register()
nua_set_params()
nua_get_params() nua_set_hparams()
nua_get_hparams()
Parameter type
unsigned int
Values
  • 0 - disable keepalives
  • 120000 - default value (120000 milliseconds, 120 seconds)
Corresponding tag taking reference parameter is NUTAG_KEEPALIVE_REF()

#define NUTAG_KEEPALIVE_STREAM (  ) 

Transport-level keepalive interval for streams.

Used with
nua_register()
nua_set_params()
nua_get_params() nua_set_hparams()
nua_get_hparams()
Parameter type
unsigned int
Values
Transport-level keepalive interval for streams in milliseconds. If this parameter specified, it takes presedence over value given in NUTAG_KEEPALIVE().

Corresponding tag taking reference parameter is NUTAG_KEEPALIVE_STREAM_REF()

Todo:
Actually pass NUTAG_KEEPALIVE_STREAM() to transport layer.

#define NUTAG_MAX_SUBSCRIPTIONS (  ) 

Set maximum number of simultaneous subscribers per single event server.

Determines how many subscribers can simultaneously subscribe to a single event.

Used with
nua_set_params()
nua_get_params()
Parameter type
unsigned
Values
0 Do not allow any subscriptions
Corresponding tag taking reference parameter is NUTAG_MAX_SUBSCRIPTIONS_REF()

#define NUTAG_MEDIA_ENABLE (  ) 

Enable local media (MSS).

Used with
nua_create()
Parameter type
int
Values
0 False
!=0 True
Corresponding tag taking reference parameter is NUTAG_MEDIA_ENABLE_REF()

#define NUTAG_MEDIA_FEATURES (  ) 

Add media tags from our offer to Accept-Contact headers.

Automatically generate Accept-Contact headers for caller preference processing according to our current media capabilities.

Used with
nua_invite()
nua_update()
nua_set_params()
nua_get_params()
Parameter type
int
Values
0 Do not add media tags
!=0 Add media tags
Corresponding tag taking reference parameter is NUTAG_MEDIA_FEATURES_REF()

#define NUTAG_MIN_SE (  ) 

Minimum acceptable refresh interval for session.

Specifies the value of Min-SE header in seconds.

Used with
nua_set_params()
nua_get_params()
Parameter type
unsigned int
Values
interval in seconds.
Corresponding tag taking reference parameter is NUTAG_MIN_SE_REF()

#define NUTAG_NOTIFY_REFER (  ) 

Refer reply handle (used with refer).

When making a call in response to a REFER request [RFC3515] with nua_invite(), the application can ask NUA to automatically generate notifications about the call progress to the referrer. In order to do that the application should pass to the stack the handle, which it used to receive the REFER request. It should also pass the event header object along with the handle using NUTAG_REFER_EVENT().

Used with
nua_invite()
Parameter type
nua_handle_t *
Values
Corresponding tag taking reference parameter is NUTAG_NOTIFY_REFER_REF()

#define NUTAG_OFFER_RECV (  ) 

Indicate that SDP offer has been received.

Used with
nua_i_state
Parameter type
boolean
Corresponding tag taking reference parameter is NUTAG_OFFER_RECV_REF()

#define NUTAG_OFFER_SENT (  ) 

Indicate that SDP offer has been sent.

Used with
nua_i_state
Parameter type
boolean
Corresponding tag taking reference parameter is NUTAG_OFFER_SENT_REF()

#define NUTAG_ONLY183_100REL (  ) 

Respond only 183 with 100rel.

If this parameter is set, stack uses 100rel only with 183: otherwise, all 1XX responses (except 100 Trying) uses 100rel.

Used with
nua_set_params()
nua_get_params()
Parameter type
int (boolean)
Values
0 False
!=0 True
Corresponding tag taking reference parameter is NUTAG_ONLY183_100REL_REF()

#define NUTAG_OUTBOUND (  ) 

Outbound option string.

The outbound option string can specify how the NAT traversal is handled. The option tokens are as follows:

An option token with "no-" or "not-" prefix turns the option off. For example, if you want to try to traverse NATs but not to use OPTIONS keepalive, use NUTAG_OUTBOUND("natify no-options-keepalive").

Note:
Options string is used so that no new tags need to be added when the outbound functionality changes.
Used with
nua_register()
nua_set_params()
nua_get_params() nua_set_hparams()
nua_get_hparams()
Parameter type
char const *
Values
Corresponding tag taking reference parameter is NUTAG_OUTBOUND_REF()

#define NUTAG_PATH_ENABLE (  ) 

If true, add "path" to Supported in REGISTER.

See also:
RFC 3327, "SIP Extension Header Field for Registering Non-Adjacent Contacts", D. Willis, B. Hoeneisen, December 2002.

#define NUTAG_PHRASE (  ) 

Response phrase.

Used with
Currently not processed by NUA
Parameter type
char const *
Values
Corresponding tag taking reference parameter is NUTAG_PHRASE_REF()

#define NUTAG_PROXY (  ) 

Outbound proxy URL.

Same tag as NTATAG_DEFAULT_PROXY

Used with
nua_set_params()
nua_get_params()
nua_create()
Parameter type
url_string_t const * (either char const * or url_t *)
Values
Corresponding tag taking reference parameter is NUTAG_PROXY_REF()

#define NUTAG_REFER_EVENT (  ) 

Event used with automatic refer notifications.

When creating a call in response to a REFER request [RFC3515] the application can ask NUA to automatically generate notifications about the call progress to the referrer. The nua_i_refer event will contain a suitable SIP event header for the notifications in the NUTAG_REFER_EVENT() tag. The application should store the SIP event header and when it makes the referred call, it should pass it back to the stack again using the NUTAG_REFER_EVENT() tag.

Used with
Parameter type
sip_event_t *
Values
Corresponding tag taking reference parameter is NUTAG_REFER_EVENT_REF()

#define NUTAG_REFER_EXPIRES (  ) 

Default lifetime for implicit subscriptions created by REFER.

Default expiration time in seconds for implicit subscriptions created by REFER.

Used with
nua_set_params()
nua_get_params()
nua_set_hparams()
nua_get_hparams()
Parameter type
unsigned int
Values
0 disable
>0 interval in seconds
Corresponding tag taking reference parameter is NUTAG_REFER_EXPIRES()

#define NUTAG_REFER_PAUSE (  ) 

Invite pauses referrer's handle.

When creating a call in response to a REFER [RFC3515] request, the application can ask that the original call will be muted when the new call is connected by specifying NUTAG_REFER_PAUSE() along with NUTAG_NOTIFY_REFER() as a parameter to nua_invite() call.

Used with
nua_invite()
Parameter type
int
Values
0 False !=0 True
Corresponding tag taking reference parameter is NUTAG_REFER_PAUSE_REF()

#define NUTAG_REGISTRAR (  ) 

Registrar URL.

Used with
nua_register()
nua_set_params()
nua_get_params()
Parameter type
url_string_t const * (either char const * or url_t *)
Values
Corresponding tag taking reference parameter is NUTAG_REGISTRAR_REF()

#define NUTAG_RETRY_COUNT (  ) 

Set request retry count.

Retry count determines how many times stack will automatically retry after an recoverable error response, like 302, 401 or 407.

Used with
nua_set_params()
nua_get_params()
Parameter type
unsigned
Values
0 Never retry automatically
Corresponding tag taking reference parameter is NUTAG_RETRY_COUNT_REF()

#define NUTAG_SERVICE_ROUTE_ENABLE (  ) 

Use route from Service-Route header in response to REGISTER.

See also:
RFC 3327, "SIP Extension Header Field for Registering Non-Adjacent Contacts", D. Willis, B. Hoeneisen, December 2002.

#define NUTAG_SESSION_REFRESHER (  ) 

Specify preferred refresher.

Specify for session timer extension which party is the preferred refresher.

Used with
nua_set_params()
nua_get_params()
Parameter type
enum { nua_no_refresher, nua_local_refresher, nua_remote_refresher, nua_any_refresher }
Values
nua_no_refresher (session timers are disabled)
nua_local_refresher
nua_remote_refresher
nua_any_refresher (default)
Corresponding tag taking reference parameter is NUTAG_SESSION_REFRESHER_REF()

#define NUTAG_SESSION_TIMER (  ) 

Default session timer in seconds.

Set default session timer in seconds when using session timer extension. Re-INVITE will be sent in given intervals.

Used with
nua_set_params()
nua_get_params()
Parameter type
unsigned int
Values
0 disable
>0 interval in seconds
Corresponding tag taking reference parameter is NUTAG_SESSION_TIMER_REF()

#define NUTAG_SIP_PARSER (  ) 

Pointer to SIP parser structure.

Used with
nua_create()
Parameter type
msg_mclass_t *
Values
Pointer to an extended SIP parser.
See also:
msg_mclass_clone(), msg_mclass_insert_header()
Corresponding tag taking reference parameter is NUTAG_SIP_PARSER_REF().

#define NUTAG_SIPS_URL (  ) 

Local SIPS url.

The application can specify an alternative local address for NUA user agent engine. Usually the alternative address is a secure SIP URI (SIPS) used with TLS transport.

Used with
nua_create()
Parameter type
char const *
Values
Corresponding tag taking reference parameter is NUTAG_SIPS_URL_REF()

#define NUTAG_SMIME_ENABLE (  ) 

Enable S/MIME.

Used with
nua_create()
nua_set_params()
nua_get_params()
Parameter type
boolean
Values
0 S/MIME is Disabled
!=0 S/MIME is Enabled
Corresponding tag taking reference parameter is NUTAG_SMIME_ENABLE_REF()

#define NUTAG_SMIME_KEY_ENCRYPTION (  ) 

S/MIME key encryption algorithm.

This tag specifies the key encryption algorithm to be used by S/MIME.

Used with
To be implemented
Parameter type
char const *
Values
Corresponding tag taking reference parameter is NUTAG_SMIME_KEY_ENCRYPTION_REF()

#define NUTAG_SMIME_MESSAGE_DIGEST (  ) 

S/MIME digest algorithm.

This tag specifies the message digest algorithm to be used in S/MIME.

Used with
To be implemented
Parameter type
char const *
Values
Corresponding tag taking reference parameter is NUTAG_SMIME_MESSAGE_DIGEST_REF()

#define NUTAG_SMIME_MESSAGE_ENCRYPTION (  ) 

S/MIME message encryption algorithm.

This tag specifies the message encryption algorithm to be used in S/MIME.

Used with
To be implemented.
Parameter type
char const *
Values
Corresponding tag taking reference parameter is NUTAG_SMIME_MESSAGE_ENCRYPTION_REF()

#define NUTAG_SMIME_OPT (  ) 

S/MIME Options.

This tag specifies the type of S/MIME security services requested by the user.

Used with
nua_set_params()
nua_get_params()
nua_message()
Parameter type
int
Values
-1 (SM_ID_NULL) No security service needed
0 (SM_ID_CLEAR_SIGN) Clear signing
1 (SM_ID_SIGN) S/MIME signing
2 (SM_ID_ENCRYPT) S/MIME encryption
Corresponding tag taking reference parameter is NUTAG_SMIME_OPT_REF()

#define NUTAG_SMIME_PROTECTION_MODE (  ) 

S/MIME protection mode.

This tag specifies the protection mode of the SIP message by S/MIME as requested by the user

Used with
nua_set_params()
nua_get_params()
Parameter type
unsigned int
Values
-1 (SM_MODE_NULL) Unspecified
0 (SM_MODE_PAYLOAD_ONLY) SIP payload only
1 (SM_MODE_TUNNEL) SIP tunneling mode
2 (SM_MODE_SIPFRAG) SIPfrag protection
Corresponding tag taking reference parameter is NUTAG_SMIME_PROTECTION_MODE_REF()

#define NUTAG_SMIME_SIGNATURE (  ) 

S/MIME signature algorithm.

This tag specifies the signature algorithm to be used in S/MIME.

Used with
To be implemented.
Parameter type
char const *
Values
Corresponding tag taking reference parameter is NUTAG_SMIME_SIGNATURE_REF()

#define NUTAG_SOA_NAME (  ) 

Name for SDP Offer-Answer session object.

SDP Offer-Answer session object name.

Used with nua_create(), nua_handle().
Parameter type
void * (actually soa_session_t *)
Values
Pointer to MSS media session.
Corresponding tag taking reference parameter is NUTAG_SOA_SESSION_REF.

#define NUTAG_STATUS (  ) 

Response status code.

Used with
Currently not processed by NUA
Parameter type
unsigned int
Values
100 - preliminary response, request is being processed by next hop
1XX - preliminary response, request is being processed by UAS
2XX - successful final response
3XX - redirection error response
4XX - client error response
5XX - server error response
6XX - global error response
Corresponding tag taking reference parameter is NUTAG_STATUS_REF()

#define NUTAG_SUBSTATE (  ) 

Subscription state.

Used with
nua_r_subscribe
nua_i_notify
Parameter type
int
Values
nua_substate_embryonic (0)
nua_substate_pending (1)
nua_substate_active (2)
nua_substate_terminated (3)
see RFC 3265

Corresponding tag taking reference parameter is NUTAG_SUBSTATE_REF()

#define NUTAG_UPDATE_REFRESH (  ) 

Use UPDATE as refresh method.

Used with
nua_set_params()
nua_get_params()
Parameter type
boolean
Values
1 Use UPDATE
0 Use INVITE
Corresponding tag taking reference parameter is NUTAG_UPDATE_REFRESH_REF()

#define NUTAG_URL (  ) 

URL address from application to NUA.

Used with
nua_create()
nua_set_params()
nua_get_params()
other calls that create SIP request
Parameter type
char const *
Values
NULL terminated character string
Own address for nua_create(), nua_set_params() and nua_get_params().
Target address for other calls.
Corresponding tag taking reference parameter is NUTAG_URL_REF

#define NUTAG_USE_DIALOG (  ) 

Ask NUA to create dialog for this handle.

Used with nua calls that send a SIP request
Parameter type
int
Values
False (zero)
True (nonzero)
Corresponding tag taking reference parameter is NUTAG_USE_DIALOG_REF()

#define NUTAG_USER_AGENT (  ) 

User-Agent string.

Used with
nua_set_params()
nua_get_params()
Parameter type
char const *
Values
see RFC 3261
default string is of format "nua/2.0"
Corresponding tag taking reference parameter is NUTAG_USER_AGENT_REF()


Enumeration Type Documentation

enum nua_callstate

Enumerator:
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.
nua_callstate_early  18X sent (w/SDP)
nua_callstate_completed  2XX sent
nua_callstate_ready  2XX received, ACK sent, or vice versa
nua_callstate_terminating  BYE sent.
nua_callstate_terminated  BYE complete.


Sofia-SIP 1.12.1 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.