#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 NUTAG_ADDRESS | ( | x | ) |
Address as a string.
#define NUTAG_ALLOW | ( | x | ) |
Allow a method (or methods).
#define NUTAG_ANSWER_RECV | ( | x | ) |
Indicate that SDP answer has been received.
#define NUTAG_ANSWER_SENT | ( | x | ) |
Indicate that SDP answer has been sent.
#define NUTAG_AUTH | ( | x | ) |
Authentication data ("scheme" "realm" "user" "password").
Digest:"nokia proxy":xyz:secret
#define NUTAG_AUTHTIME | ( | x | ) |
Lifetime of authentication data in seconds.
0
Use authentication data only for this handle !=0
Lifetime in seconds#define NUTAG_AUTOACK | ( | x | ) |
ACK automatically.
0
No automatic sending of ACK !=0
ACK sent automatically#define NUTAG_AUTOALERT | ( | x | ) |
Send alerting (180 Ringing) automatically.
0
No automatic sending of "180 Ringing" !=0
"180 Ringing" sent automatically#define NUTAG_AUTOANSWER | ( | x | ) |
Answer (200 Ok) automatically to incoming call.
0
No automatic sending of "200 Ok" !=0
"200 Ok" sent automatically#define NUTAG_CALLSTATE | ( | x | ) |
Call state.
nua_callstate_init
- Initial statenua_callstate_authenticating
- 401/407 receivednua_callstate_calling
- INVITE sentnua_callstate_proceeding
- 18X receivednua_callstate_received
- INVITE receivednua_callstate_early
- 18X sent (w/SDP)nua_callstate_ready
- 2XX received or sentnua_callstate_terminating
- BYE sentnua_callstate_terminated
- BYE complete#define NUTAG_CERTIFICATE_DIR | ( | x | ) |
x.500 certificate directory
#define NUTAG_CERTIFICATE_PHRASE | ( | x | ) |
Certificate phrase.
#define NUTAG_EARLY_MEDIA | ( | x | ) |
Establish early media session using 183 responses and PRACK requests.
0
False !=0
True#define NUTAG_ENABLEINVITE | ( | x | ) |
Enable incoming INVITE.
0
Incoming INVITE not enabled. NUA answers 403 Forbidden !=0
Incoming INVITE enabled#define NUTAG_ENABLEMESSAGE | ( | x | ) |
Enable incoming MESSAGE.
0
Incoming MESSAGE not enabled. NUA answers 403 Forbidden !=0
Incoming MESSAGE enabled#define NUTAG_ENABLEMESSENGER | ( | x | ) |
Enable incoming MESSAGE with To tag.
Set this parameter if you want to chat with Windows Messenger.
0
False !=0
True#define NUTAG_EVENT | ( | x | ) |
Events.
#define NUTAG_HANDLE | ( | x | ) |
NUA Handle.
#define NUTAG_IDENTITY | ( | x | ) |
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.
#define NUTAG_INSTANCE | ( | x | ) |
Intance identifier.
#define NUTAG_INVITE_TIMER | ( | x | ) |
Timer for outstanding INVITE in seconds.
INVITE will be canceled if no answer is received before timer expires.
0
no timer >0
timer in seconds#define NUTAG_KEEPALIVE | ( | x | ) |
Keepalive interval in milliseconds.
#define NUTAG_KEEPALIVE_STREAM | ( | x | ) |
Transport-level keepalive interval for streams.
Corresponding tag taking reference parameter is NUTAG_KEEPALIVE_STREAM_REF()
#define NUTAG_MAX_SUBSCRIPTIONS | ( | x | ) |
Set maximum number of simultaneous subscribers per single event server.
Determines how many subscribers can simultaneously subscribe to a single event.
0
Do not allow any subscriptions #define NUTAG_MEDIA_ENABLE | ( | x | ) |
Enable local media (MSS).
0
False !=0
True#define NUTAG_MEDIA_FEATURES | ( | x | ) |
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.
0
Do not add media tags !=0
Add media tags#define NUTAG_MIN_SE | ( | x | ) |
Minimum acceptable refresh interval for session.
Specifies the value of Min-SE header in seconds.
#define NUTAG_NOTIFY_REFER | ( | x | ) |
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().
#define NUTAG_OFFER_RECV | ( | x | ) |
Indicate that SDP offer has been received.
#define NUTAG_OFFER_SENT | ( | x | ) |
Indicate that SDP offer has been sent.
#define NUTAG_ONLY183_100REL | ( | x | ) |
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.
0
False !=0
True#define NUTAG_OUTBOUND | ( | x | ) |
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").
#define NUTAG_PATH_ENABLE | ( | x | ) |
If true, add "path" to Supported in REGISTER.
#define NUTAG_PHRASE | ( | x | ) |
Response phrase.
#define NUTAG_PROXY | ( | x | ) |
Outbound proxy URL.
Same tag as NTATAG_DEFAULT_PROXY
#define NUTAG_REFER_EVENT | ( | x | ) |
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.
#define NUTAG_REFER_EXPIRES | ( | x | ) |
Default lifetime for implicit subscriptions created by REFER.
Default expiration time in seconds for implicit subscriptions created by REFER.
0
disable >0
interval in seconds#define NUTAG_REFER_PAUSE | ( | x | ) |
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.
0
False !=0
True#define NUTAG_REGISTRAR | ( | x | ) |
Registrar URL.
#define NUTAG_RETRY_COUNT | ( | x | ) |
Set request retry count.
Retry count determines how many times stack will automatically retry after an recoverable error response, like 302, 401 or 407.
0
Never retry automatically #define NUTAG_SERVICE_ROUTE_ENABLE | ( | x | ) |
Use route from Service-Route header in response to REGISTER.
#define NUTAG_SESSION_REFRESHER | ( | x | ) |
Specify preferred refresher.
Specify for session timer extension which party is the preferred refresher.
nua_no_refresher
(session timers are disabled) nua_local_refresher
nua_remote_refresher
nua_any_refresher
(default) #define NUTAG_SESSION_TIMER | ( | x | ) |
Default session timer in seconds.
Set default session timer in seconds when using session timer extension. Re-INVITE will be sent in given intervals.
0
disable >0
interval in seconds#define NUTAG_SIP_PARSER | ( | x | ) |
Pointer to SIP parser structure.
#define NUTAG_SIPS_URL | ( | x | ) |
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.
#define NUTAG_SMIME_ENABLE | ( | x | ) |
Enable S/MIME.
0
S/MIME is Disabled !=0
S/MIME is Enabled#define NUTAG_SMIME_KEY_ENCRYPTION | ( | x | ) |
S/MIME key encryption algorithm.
This tag specifies the key encryption algorithm to be used by S/MIME.
#define NUTAG_SMIME_MESSAGE_DIGEST | ( | x | ) |
S/MIME digest algorithm.
This tag specifies the message digest algorithm to be used in S/MIME.
#define NUTAG_SMIME_MESSAGE_ENCRYPTION | ( | x | ) |
S/MIME message encryption algorithm.
This tag specifies the message encryption algorithm to be used in S/MIME.
#define NUTAG_SMIME_OPT | ( | x | ) |
S/MIME Options.
This tag specifies the type of S/MIME security services requested by the user.
-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#define NUTAG_SMIME_PROTECTION_MODE | ( | x | ) |
S/MIME protection mode.
This tag specifies the protection mode of the SIP message by S/MIME as requested by the user
-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#define NUTAG_SMIME_SIGNATURE | ( | x | ) |
S/MIME signature algorithm.
This tag specifies the signature algorithm to be used in S/MIME.
#define NUTAG_SOA_NAME | ( | x | ) |
Name for SDP Offer-Answer session object.
SDP Offer-Answer session object name.
#define NUTAG_STATUS | ( | x | ) |
Response status code.
#define NUTAG_SUBSTATE | ( | x | ) |
Subscription state.
nua_substate_embryonic
(0) nua_substate_pending
(1) nua_substate_active
(2) nua_substate_terminated
(3) Corresponding tag taking reference parameter is NUTAG_SUBSTATE_REF()
#define NUTAG_UPDATE_REFRESH | ( | x | ) |
Use UPDATE as refresh method.
1
Use UPDATE 0
Use INVITE#define NUTAG_URL | ( | x | ) |
URL address from application to NUA.
#define NUTAG_USE_DIALOG | ( | x | ) |
Ask NUA to create dialog for this handle.
False
(zero) True
(nonzero)#define NUTAG_USER_AGENT | ( | x | ) |
User-Agent string.
enum nua_callstate |