kenmirrors
/
freeswitch
mirror of https://github.com/signalwire/freeswitch.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Wed Sep 3 13:50:17 EDT 2008 Pekka Pessi <first.last@nokia.com> 

* nua_tag.c: updated documentation on NUA tags



git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@9419 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Michael Jerris 2008-09-03 18:28:41 +00:00
parent 8e37367fb6
commit fc0293d266
1 changed files with 201 additions and 195 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
libs/sofia-sip/libsofia-sip-ua/nua/nua_tag.c
View File

@ -299,7 +299,7 @@ tag_typedef_t nutag_any = NSTAG_TYPEDEF(*);
* *
* @par Values * @par Values
* #url_string_t, which is either a pointer to #url_t or NULL terminated * #url_string_t, which is either a pointer to #url_t or NULL terminated
* character string representing URL \n * character string representing URL
* *
* For normal nua calls, this tag is used as request target, which is usually * For normal nua calls, this tag is used as request target, which is usually
* stored as request-URI. * stored as request-URI.
@ -445,9 +445,9 @@ tag_typedef_t nutag_early_media = BOOLTAG_TYPEDEF(early_media);
* *
* Require 100rel extension and PRACK only with 183 response. * Require 100rel extension and PRACK only with 183 response.
* *
* If this parameter is set, stack includes feature tag "100rel" in the * When NUTAG_EARLY_MEDIA() is set, and if this parameter is set, stack
* @Require header only with 183: otherwise, all 1XX responses (except * includes feature tag "100rel" in the @Require header only with 183:
* <i>100 Trying</i>) require 100rel. * otherwise, all 1XX responses (except <i>100 Trying</i>) require 100rel.
* *
* @par Used with * @par Used with
* nua_set_params() \n * nua_set_params() \n
@ -487,11 +487,11 @@ tag_typedef_t nutag_only183_100rel = BOOLTAG_TYPEDEF(only183_100rel);
* nua_respond(), nua_set_params(), nua_set_hparams() * nua_respond(), nua_set_params(), nua_set_hparams()
* *
* @par Parameter type * @par Parameter type
* int (boolean) * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 False \n * - 0 (false) - do not include SDP in non-100rel 1XX responses
* @c !=0 True * - 1 (true) - try to include SDP in preliminary responses
* *
* Corresponding tag taking reference parameter is NUTAG_EARLY_ANSWER_REF(). * Corresponding tag taking reference parameter is NUTAG_EARLY_ANSWER_REF().
* *
@ -523,11 +523,12 @@ tag_typedef_t nutag_early_answer = BOOLTAG_TYPEDEF(early_answer);
* nua_respond() * nua_respond()
* *
* @par Parameter type * @par Parameter type
* int (boolean) * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 False \n * - 0 (false) - do not include extra SDP on 200 OK
* @c !=0 True * - 1 (true) - include SDP in 200 OK even if it has been sent
* a 100rel response, too
* *
* Corresponding tag taking reference parameter is * Corresponding tag taking reference parameter is
* NUTAG_INCLUDE_EXTRA_SDP_REF(). * NUTAG_INCLUDE_EXTRA_SDP_REF().
@ -560,8 +561,8 @@ tag_typedef_t nutag_include_extra_sdp = BOOLTAG_TYPEDEF(include_extra_sdp);
* int * int
* *
* @par Values * @par Values
* @c 0 False \n * - 0 (false) - do not use soa
* @c !=0 True * - 1 (true) - use soa with SDP O/A
* *
* Corresponding tag taking reference parameter is NUTAG_MEDIA_ENABLE_REF() * Corresponding tag taking reference parameter is NUTAG_MEDIA_ENABLE_REF()
*/ */
@ -620,7 +621,7 @@ tag_typedef_t nutag_soa_name = STRTAG_TYPEDEF(soa_name);
* unsigned * unsigned
* *
* @par Values * @par Values
* - 0 - Never retry automatically \n * - 0 - Never retry automatically
* - Otherwise, number of extra transactions initiated after initial * - Otherwise, number of extra transactions initiated after initial
* transaction failed with recoverable error response * transaction failed with recoverable error response
* *
@ -648,10 +649,10 @@ tag_typedef_t nutag_retry_count = UINTTAG_TYPEDEF(retry_count);
* nua_get_params() * nua_get_params()
* *
* @par Parameter type * @par Parameter type
* unsigned * unsigned int
* *
* @par Values * @par Values
* @c 0 Do not allow any subscriptions \n * - 0 (zero) - do not allow any subscriptions
* *
* @sa nua_notifier(), nua_authorize() * @sa nua_notifier(), nua_authorize()
* *
@ -871,12 +872,12 @@ tag_typedef_t nutag_sub_expires = UINTTAG_TYPEDEF(substate);
* nua_notify() * nua_notify()
* *
* @par Parameter type * @par Parameter type
* int (boolean) * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* - 0 - false (default) - do not create new subscription * - 0 - false (default) - do not create new subscription
* but reject NOTIFY with 481 locally \n * but reject NOTIFY with 481 locally
* - 1 - true - create a subscription if it does not exist \n * - 1 - true - create a subscription if it does not exist
* *
* Corresponding tag taking reference parameter is NUTAG_NEWSUB_REF(). * Corresponding tag taking reference parameter is NUTAG_NEWSUB_REF().
* *
@ -904,8 +905,8 @@ tag_typedef_t nutag_newsub = BOOLTAG_TYPEDEF(newsub);
* int (enum nua_af) * int (enum nua_af)
* *
* @par Values * @par Values
* @c 0 no timer \n * - 0 no timer
* @c >0 timer in seconds * - >0 timer in seconds
* *
* Corresponding tag taking reference parameter is NUTAG_INVITE_TIMER_REF(). * Corresponding tag taking reference parameter is NUTAG_INVITE_TIMER_REF().
*/ */
@ -1055,10 +1056,10 @@ tag_typedef_t nutag_min_se = UINTTAG_TYPEDEF(min_se);
* #nua_any_refresher } * #nua_any_refresher }
* *
* @par Values * @par Values
* @c nua_no_refresher (session timers are disabled) \n * - nua_no_refresher (session timers are disabled)
* @c nua_local_refresher \n * - nua_local_refresher
* @c nua_remote_refresher \n * - nua_remote_refresher
* @c nua_any_refresher (default) \n * - nua_any_refresher (default)
* *
* Corresponding tag taking reference parameter is * Corresponding tag taking reference parameter is
* NUTAG_SESSION_REFRESHER_REF(). * NUTAG_SESSION_REFRESHER_REF().
@ -1096,11 +1097,11 @@ tag_typedef_t nutag_session_refresher = INTTAG_TYPEDEF(session_refresher);
* accept this tag. * accept this tag.
* *
* @par Parameter type * @par Parameter type
* boolean * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 1 Use UPDATE \n * - 1 (true, use UPDATE)
* @c 0 Use INVITE * - 0 (false, use INVITE)
* *
* Corresponding tag taking reference parameter is NUTAG_UPDATE_REFRESH_REF(). * Corresponding tag taking reference parameter is NUTAG_UPDATE_REFRESH_REF().
* *
@ -1162,11 +1163,11 @@ tag_typedef_t nutag_refer_expires = UINTTAG_TYPEDEF(refer_expires);
* nua_update()). * nua_update()).
* *
* @par Parameter type * @par Parameter type
* int (boolean) * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* 0 (false, do not use id with subscription created with first REFER request) \n * - 0 (false, do not use id with subscription created with first REFER request)
* 1 (true, use id with all subscriptions created with REFER request) \n * - 1 (true, use id with all subscriptions created with REFER request)
* *
* Corresponding tag taking reference parameter is NUTAG_REFER_WITH_ID_REF(). * Corresponding tag taking reference parameter is NUTAG_REFER_WITH_ID_REF().
* *
@ -1180,18 +1181,20 @@ tag_typedef_t nutag_refer_with_id = BOOLTAG_TYPEDEF(refer_with_id);
/**@def NUTAG_AUTOALERT(x) /**@def NUTAG_AUTOALERT(x)
* *
* Send alerting (180 Ringing) automatically * Send alerting (180 Ringing) automatically (instead of 100 Trying). If the
* early media has been enabled with NUTAG_EARLY_MEDIA(1), the stack will
* send 183, wait for PRACK and then return 180 Ringing.
* *
* @par Used with * @par Used with
* nua_set_params() \n * nua_set_params() \n
* nua_get_params() * nua_get_params()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 No automatic sending of "180 Ringing" \n * - 0 (false) - no automatic sending of "180 Ringing"
* @c !=0 "180 Ringing" sent automatically * - 1 (true) - "180 Ringing" sent automatically
* *
* Corresponding tag taking reference parameter is NUTAG_AUTOALERT_REF(). * Corresponding tag taking reference parameter is NUTAG_AUTOALERT_REF().
*/ */
@ -1213,7 +1216,7 @@ tag_typedef_t nutag_autoalert = BOOLTAG_TYPEDEF(autoAlert);
* nua_respond() * nua_respond()
* *
* @par Parameter type * @par Parameter type
* int (boolean) * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* - 0 (false) - No automatic sending of "200 Ok" * - 0 (false) - No automatic sending of "200 Ok"
@ -1261,11 +1264,11 @@ tag_typedef_t nutag_autoanswer = BOOLTAG_TYPEDEF(autoAnswer);
* nua_respond() * nua_respond()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 No automatic sending of ACK \n * - 0 (false) - No automatic sending of ACK
* @c !=0 ACK sent automatically * - 1 (true) - ACK sent automatically
* *
* Default value is NUTAG_AUTOACK(1). * Default value is NUTAG_AUTOACK(1).
* *
@ -1288,11 +1291,11 @@ tag_typedef_t nutag_autoack = BOOLTAG_TYPEDEF(autoACK);
* nua_get_params() * nua_get_params()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 Incoming INVITE not enabled. NUA answers 403 Forbidden \n * - 0 (false) - Incoming INVITE not enabled. NUA answers 403 Forbidden
* @c !=0 Incoming INVITE enabled * - 1 (true) - Incoming INVITE enabled
* *
* Corresponding tag taking reference parameter is NUTAG_ENABLEINVITE_REF(). * Corresponding tag taking reference parameter is NUTAG_ENABLEINVITE_REF().
*/ */
@ -1313,11 +1316,11 @@ tag_typedef_t nutag_enableinvite = BOOLTAG_TYPEDEF(enableInvite);
* nua_get_params() * nua_get_params()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 Incoming MESSAGE not enabled. NUA answers 403 Forbidden \n * - 0 (false) - Incoming MESSAGE not enabled. NUA answers 403 Forbidden
* @c !=0 Incoming MESSAGE enabled * - 1 (true) - Incoming MESSAGE enabled
* *
* Corresponding tag taking reference parameter is NUTAG_ENABLEMESSAGE_REF(). * Corresponding tag taking reference parameter is NUTAG_ENABLEMESSAGE_REF().
*/ */
@ -1333,18 +1336,20 @@ tag_typedef_t nutag_enablemessage = BOOLTAG_TYPEDEF(enableMessage);
* *
* Enable incoming MESSAGE with To tag. * Enable incoming MESSAGE with To tag.
* *
* Set this parameter if you want to chat with Windows Messenger. * Set this parameter true if you want to chat with Windows Messenger. When
* it is set, stack will accept MESSAGE requests with To tag outside
* existing dialogs.
* *
* @par Used with * @par Used with
* nua_set_params() \n * nua_set_params() \n
* nua_get_params() * nua_get_params()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 False \n * - 0 (false) - disable Windows-Messenger-specific features
* @c !=0 True * - 1 (true) - enable Windows-Messenger-specific features
* *
* Corresponding tag taking reference parameter is NUTAG_ENABLEMESSENGER_REF(). * Corresponding tag taking reference parameter is NUTAG_ENABLEMESSENGER_REF().
*/ */
@ -1365,11 +1370,11 @@ tag_typedef_t nutag_enablemessenger = BOOLTAG_TYPEDEF(enableMessenger);
* nua_get_params() * nua_get_params()
* *
* @par Parameter type * @par Parameter type
* boolean * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 S/MIME is Disabled \n * - 0 (false) - S/MIME is Disabled
* @c !=0 S/MIME is Enabled * - 1 (true) - S/MIME is Enabled
* *
* Corresponding tag taking reference parameter is NUTAG_SMIME_ENABLE_REF(). * Corresponding tag taking reference parameter is NUTAG_SMIME_ENABLE_REF().
*/ */
@ -1396,10 +1401,10 @@ tag_typedef_t nutag_smime_enable = BOOLTAG_TYPEDEF(smime_enable);
* int * int
* *
* @par Values * @par Values
* @c -1 (SM_ID_NULL) No security service needed \n * - -1 (SM_ID_NULL) No security service needed
* @c 0 (SM_ID_CLEAR_SIGN) Clear signing \n * - 0 (SM_ID_CLEAR_SIGN) Clear signing
* @c 1 (SM_ID_SIGN) S/MIME signing \n * - 1 (SM_ID_SIGN) S/MIME signing
* @c 2 (SM_ID_ENCRYPT) S/MIME encryption * - 2 (SM_ID_ENCRYPT) S/MIME encryption
* *
* Corresponding tag taking reference parameter is NUTAG_SMIME_OPT_REF(). * Corresponding tag taking reference parameter is NUTAG_SMIME_OPT_REF().
*/ */
@ -1425,10 +1430,10 @@ tag_typedef_t nutag_smime_opt = INTTAG_TYPEDEF(smime_opt);
* unsigned int * unsigned int
* *
* @par Values * @par Values
* @c -1 (SM_MODE_NULL) Unspecified \n * - -1 (SM_MODE_NULL) Unspecified
* @c 0 (SM_MODE_PAYLOAD_ONLY) SIP payload only \n * - 0 (SM_MODE_PAYLOAD_ONLY) SIP payload only
* @c 1 (SM_MODE_TUNNEL) SIP tunneling mode \n * - 1 (SM_MODE_TUNNEL) SIP tunneling mode
* @c 2 (SM_MODE_SIPFRAG) SIPfrag protection * - 2 (SM_MODE_SIPFRAG) SIPfrag protection
* *
* Corresponding tag taking reference parameter is NUTAG_SMIME_PROTECTION_MODE_REF(). * Corresponding tag taking reference parameter is NUTAG_SMIME_PROTECTION_MODE_REF().
*/ */
@ -2126,11 +2131,11 @@ tag_typedef_t nutag_keepalive_stream = UINTTAG_TYPEDEF(keepalive_stream);
* @par Used with nua calls that send a SIP request * @par Used with nua calls that send a SIP request
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c False (zero) \n * - 0 (false) - do not create a dialog
* @c True (nonzero) * - 1 (true) - store dialog info
* *
* Corresponding tag taking reference parameter is NUTAG_USE_DIALOG_REF(). * Corresponding tag taking reference parameter is NUTAG_USE_DIALOG_REF().
*/ */
@ -2178,8 +2183,8 @@ tag_typedef_t nutag_auth = STRTAG_TYPEDEF(auth);
* unsigned int * unsigned int
* *
* @par Values * @par Values
* @c 0 Use authentication data only for this handle \n * - 0 (zero) - Use authentication data only for this handle
* @c !=0 Lifetime in seconds * - nonzero - Lifetime of authentication data in seconds
* *
* @todo * @todo
* *
@ -2223,13 +2228,13 @@ tag_typedef_t nutag_event = INTTAG_TYPEDEF(event);
* unsigned int * unsigned int
* *
* @par Values * @par Values
* 100 - preliminary response, request is being processed by next hop \n * - 100 - preliminary response, request is being processed by next hop
* 1XX - preliminary response, request is being processed by UAS \n * - 1XX - preliminary response, request is being processed by UAS
* 2XX - successful final response \n * - 2XX - successful final response
* 3XX - redirection error response \n * - 3XX - redirection error response
* 4XX - client error response \n * - 4XX - client error response
* 5XX - server error response \n * - 5XX - server error response
* 6XX - global error response \n * - 6XX - global error response
* *
* Corresponding tag taking reference parameter is NUTAG_STATUS_REF(). * Corresponding tag taking reference parameter is NUTAG_STATUS_REF().
*/ */
@ -2348,11 +2353,11 @@ tag_typedef_t nutag_refer_event = SIPHDRTAG_NAMED_TYPEDEF(refer_event, event);
* nua_invite() * nua_invite()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 False \n * - 0 (false) - do not pause referring call
* @c !=0 True * - 1 (true) - pause referring call
* *
* Corresponding tag taking reference parameter is NUTAG_REFER_PAUSE_REF(). * Corresponding tag taking reference parameter is NUTAG_REFER_PAUSE_REF().
* *
@ -2560,11 +2565,11 @@ tag_typedef_t nutag_supported = STRTAG_TYPEDEF(supported);
* - nua_register() * - nua_register()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 Do not include "path" to @Supported header * - 0 (false) - Do not include "path" to @Supported header
* @c !=0 Include "path" to @Supported header * - 1 (true) - Include "path" to @Supported header
* *
* @sa NUTAG_SERVICE_ROUTE_ENABLE(), NUTAG_SUPPORTED(), * @sa NUTAG_SERVICE_ROUTE_ENABLE(), NUTAG_SUPPORTED(),
* NUTAG_INITIAL_ROUTE(), NUTAG_INITIAL_ROUTE_STR(), @RFC3327 * NUTAG_INITIAL_ROUTE(), NUTAG_INITIAL_ROUTE_STR(), @RFC3327
@ -2591,11 +2596,11 @@ tag_typedef_t nutag_path_enable = BOOLTAG_TYPEDEF(path_enable);
* - nua_register() * - nua_register()
* *
* @par Parameter type * @par Parameter type
* int * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* @c 0 Do not use @ServiceRoute * - 0 (false) - Do not use @ServiceRoute
* @c !=0 Use @ServiceRoute * - 1 (true) - Use @ServiceRoute
* *
* Corresponding tag taking reference parameter is NUTAG_SERVICE_ROUTE_ENABLE_REF(). * Corresponding tag taking reference parameter is NUTAG_SERVICE_ROUTE_ENABLE_REF().
* *
@ -2721,6 +2726,7 @@ tag_typedef_t nutag_detect_network_updates = UINTTAG_TYPEDEF(detect_network_upda
tag_typedef_t nutag_with = PTRTAG_TYPEDEF(with); tag_typedef_t nutag_with = PTRTAG_TYPEDEF(with);
/**@def NUTAG_DIALOG(x) /**@def NUTAG_DIALOG(x)
* *
* An (extension) method is used to create dialog or refresh target. * An (extension) method is used to create dialog or refresh target.
@ -2814,7 +2820,7 @@ tag_typedef_t nutag_dialog = UINTTAG_TYPEDEF(dialog);
* nua_create(), nua_set_params(). * nua_create(), nua_set_params().
* *
* @par Parameter type * @par Parameter type
* int (boolean) * int (boolean: nonzero is true, zero is false)
* *
* @par Values * @par Values
* - 0 (false) - pass only #nua_r_shutdown events to application during shutdown * - 0 (false) - pass only #nua_r_shutdown events to application during shutdown