Commit 8a5472ff authored by Pekka Pessi's avatar Pekka Pessi

nua.c, nua_tag.h: updated documentation.

darcs-hash:20070126150433-65a35-c166a6e22835932c06ffd304c4f8a0d57d677ad4.gz
parent 794dad15
...@@ -1103,11 +1103,26 @@ static int nua_stack_handle_make_replaces_call(void *arg) ...@@ -1103,11 +1103,26 @@ static int nua_stack_handle_make_replaces_call(void *arg)
/**Generate a @Replaces header for handle. /**Generate a @Replaces header for handle.
*
* A @Replaces header contains the @CallID value, @From and @To tags
* corresponding to SIP dialog associated with handle @a nh. Note that the
* @Replaces matches with dialog of the remote peer,
* nua_handle_by_replaces() does not return same handle (unless you swap
* rp_from_tag and rp_to_tag in @Replaces header).
*
* A @Replaces header is used in attended transfer, among other things.
*
* @param nh pointer to operation handle
* @param home memory home used to allocate the header
* @param early_only if true, include "early-only" parameter in @Replaces, too
*
* @return A newly created @Replaces header.
* *
* @since New in @VERSION_1_12_4. * @since New in @VERSION_1_12_4.
* *
* @sa nua_handle_by_replaces(), @Replaces, @RFC3891, nua_refer(), * @sa nua_handle_by_replaces(), @Replaces, @RFC3891, @RFC3515, nua_refer(),
* #nua_i_refer, @ReferTo, nta_leg_make_replaces() * #nua_i_refer(), @ReferTo, nta_leg_make_replaces(),
* sip_headers_as_url_query()
*/ */
sip_replaces_t *nua_handle_make_replaces(nua_handle_t *nh, sip_replaces_t *nua_handle_make_replaces(nua_handle_t *nh,
su_home_t *home, su_home_t *home,
...@@ -1146,7 +1161,7 @@ static int nua_stack_handle_by_replaces_call(void *arg) ...@@ -1146,7 +1161,7 @@ static int nua_stack_handle_by_replaces_call(void *arg)
* *
* @note * @note
* You should release the reference with nua_handle_unref() when you are * You should release the reference with nua_handle_unref() when you are
* done with handle. * done with the handle.
* *
* @sa nua_handle_make_replaces(), @Replaces, @RFC3891, nua_refer(), * @sa nua_handle_make_replaces(), @Replaces, @RFC3891, nua_refer(),
* #nua_i_refer, @ReferTo, nta_leg_by_replaces() * #nua_i_refer, @ReferTo, nta_leg_by_replaces()
......
...@@ -1864,18 +1864,31 @@ SOFIAPUBFUN char const *nua_callstate_name(enum nua_callstate state); ...@@ -1864,18 +1864,31 @@ SOFIAPUBFUN char const *nua_callstate_name(enum nua_callstate state);
* @par Used with * @par Used with
* #nua_notify() \n * #nua_notify() \n
* #nua_r_subscribe \n * #nua_r_subscribe \n
* #nua_i_notify * #nua_i_notify \n
* #nua_i_subscribe \n
* #nua_r_notify \n
* nua_notify() \n
* nua_respond() to SUBSCRIBE
* *
* @par Parameter type * @par Parameter type
* int * int
* *
* @par Values * @par Values
* @c nua_substate_embryonic (0) \n * - #nua_substate_embryonic (0)
* @c nua_substate_pending (1) \n * - #nua_substate_pending (1)
* @c nua_substate_active (2) \n * - #nua_substate_active (2)
* @c nua_substate_terminated (3) \n * - #nua_substate_terminated (3)
* *
* @sa @RFC3265 * Note that the @SubscriptionState or @Expires headers specified by
* application overrides the subscription state specified by
* NUTAG_SUBSTATE(). Application can terminate subscription by including
* NUTAG_SUBSTATE(nua_substate_terminated), @SubscriptionState with value
* "terminated" or @Expires header with value 0 in the NOTIFY request sent
* by nua_notify().
*
* @sa @RFC3265, @SubscriptionState, SIPTAG_SUBSCRIPTION_STATE(),
* SIPTAG_SUBSCRIPTION_STATE_STR(), #nua_r_subscribe, #nua_i_subscribe,
* #nua_i_refer, #nua_r_notify, #nua_i_notify.
* *
* Corresponding tag taking reference parameter is NUTAG_SUBSTATE_REF() * Corresponding tag taking reference parameter is NUTAG_SUBSTATE_REF()
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment