Commit cfba1b8f authored by Pekka Pessi's avatar Pekka Pessi

nua: updated documentation

darcs-hash:20070226185621-55b16-9f23ba87cc902d6ca57db6eec26d6e4096d0c4e8.gz
parent cb328e75
......@@ -2029,7 +2029,8 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
* Always present
* @param nh Pointer to operation handle.
* @param hmagic Pointer to callback context from nua_handle().
* @param sip Parsed incoming message. May be NULL.
* @param sip Headers in parsed incoming message. May be NULL.
* See also nua_current_request().
* @param tags Tag list containing more information about the state of NUA.
* May be empty.
*
......@@ -2038,17 +2039,22 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
* individual event.
*
* The events can be divided into the following categories: \n
* @par Indications:
* @par Status or Error Indications:
* #nua_i_active \n
* #nua_i_error \n
* #nua_i_fork \n
* #nua_i_media_error \n
* #nua_i_subscription \n
* #nua_i_state \n
* #nua_i_terminated
*
* @par SIP requests:
* #nua_i_ack \n
* #nua_i_bye \n
* #nua_i_cancel \n
* #nua_i_chat \n
* #nua_i_error \n
* #nua_i_fork \n
* #nua_i_info \n
* #nua_i_invite \n
* #nua_i_media_error \n
* #nua_i_message \n
* #nua_i_method \n
* #nua_i_notify \n
......@@ -2058,9 +2064,6 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
* #nua_i_refer \n
* #nua_i_register \n
* #nua_i_subscribe \n
* #nua_i_subscription \n
* #nua_i_state \n
* #nua_i_terminated \n
* #nua_i_update
*
* @par Responses:
......@@ -2122,7 +2125,8 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
*
* Outgoing call has been forked.
*
* This is sent when an INVITE request is answered with multiple 200 responses.
* This is sent when an INVITE request is answered with multiple 2XX series
* responses.
*
* @param status response status code
* @param phrase a short textual description of @a status code
......
......@@ -125,12 +125,18 @@ nua_stack_method(nua_t *nua, nua_handle_t *nh, nua_event_t e, tagi_t const *tags
* @param nh operation handle associated with the method
* @param hmagic application context associated with the handle
* (maybe NULL if outside session)
* @param sip incoming request
* @param sip headers in incoming request (see also nua_current_request())
* @param tags NUTAG_METHOD()
*
* The extension name is in sip->sip_request->rq_method_name, too.
* The extension method name is in sip->sip_request->rq_method_name, too.
*
* @sa nua_method(), #nua_r_method
* @note If the @a status is < 200, it is up to application to respond to
* the request with nua_respond(). If the handle is destroyed, the stack
* returns a <i>500 Internal Server Error</i> response to any unresponded
* request.
*
* @sa nua_method(), #nua_r_method, NUTAG_ALLOW(), NUTAG_APPL_METHOD(),
* nua_respond(), NUTAG_WITH(), NUTAG_WITH_THIS(), NUTAG_
*
* @END_NUA_EVENT
*/
......
......@@ -1300,9 +1300,9 @@ void nua_server_request_destroy(nua_server_request_t *sr)
*
* When nua protocol engine receives an incoming SIP request, it can either
* respond to the request automatically or let it up to application to
* respond to the request. The automatic answer is sent if the request fails
* because of method, SIP extension or, in some times, MIME content
* negotiation fails.
* respond to the request. The automatic response is returned to the client
* if the request fails syntax check, or the method, SIP extension or
* content negotiation fails.
*
* When responding to an incoming INVITE request, the nua_respond() can be
* called without NUTAG_WITH() (or NUTAG_WITH_CURRENT() or
......@@ -1310,13 +1310,15 @@ void nua_server_request_destroy(nua_server_request_t *sr)
* of the request being responded.
*
* In order to simplify the simple applications, most requests are responded
* automatically. The set of requests always responded by the stack include
* BYE, CANCEL and NOTIFY. The application can add methods that it likes to
* handle by itself with NUTAG_APPL_METHOD(). The default set of
* NUTAG_APPL_METHOD() includes INVITE, PUBLISH, REGISTER and SUBSCRIBE.
* Note that unless the method is also included in the set of allowed
* methods with NUTAG_ALLOW(), the stack will respond to the incoming
* methods with <i>405 Not Allowed</i>.
* automatically. The BYE and CANCEL requests are always responded by the
* stack. Likewise, the NOTIFY requests associated with an event
* subscription are responded by the stack.
*
* The application can add methods that it likes to handle by itself with
* NUTAG_APPL_METHOD(). The default set of NUTAG_APPL_METHOD() includes
* INVITE, PUBLISH, REGISTER and SUBSCRIBE. Note that unless the method is
* also included in the set of allowed methods with NUTAG_ALLOW(), the stack
* will respond to the incoming methods with <i>405 Not Allowed</i>.
*
* Note that certain methods are rejected outside a SIP session (created
* with INVITE transaction). They include BYE, UPDATE, PRACK and INFO. Also
......@@ -1655,7 +1657,7 @@ int nua_base_server_report(nua_server_request_t *sr, tagi_t const *tags)
* The crm_init() is called when the template message and dialog leg has
* been created and populated by the tags procided by the application. Its
* parameters msg and sip are pointer to the template request message that
* is saved in the @ref "cr_msg" nua_client_request::cr_msg field.
* is saved in the nua_client_request::cr_msg field.
*
* The crm_send() is called with a copy of the template message that has
* been populated with all the fields included in the request, including
......
......@@ -571,6 +571,7 @@ SOFIAPUBVAR tag_typedef_t nutag_min_se;
#define NUTAG_MIN_SE_REF(x) nutag_min_se_ref, tag_uint_vr((&(x)))
SOFIAPUBVAR tag_typedef_t nutag_min_se_ref;
/** Enumeration type of NUTAG_SESSION_REFRESHER(). */
enum nua_session_refresher {
nua_no_refresher, /**< Disable session timer. */
nua_local_refresher, /**< Session refresh by local end. */
......
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