Commit 759272fe authored by Pekka Pessi's avatar Pekka Pessi

Updated documentation in nua.

darcs-hash:20060329161236-65a35-93660384551dacc4abd8520948b1dc1147ee1110.gz
parent 5ddb550b
......@@ -19,4 +19,5 @@ TAGFILES += ../docs/doxytags_sdp=../sdp
GENERATE_TAGFILE = ../docs/doxytags_nua
ALIASES +=
ALIASES += CFILE="@internal @file" IFILE="@internal @file"
VERBATIM_HEADERS = NO
\ No newline at end of file
......@@ -100,13 +100,14 @@ su_log_t nua_log[] = { SU_LOG_INIT("nua", "NUA_DEBUG", SU_DEBUG) };
* @retval NULL upon an error
*
* @par Related tags:
* #NUTAG_MEDIA_ENABLE \n
* #NUTAG_PROXY \n
* #NUTAG_SIP_PARSER \n
* #NUTAG_SIPS_URL \n
* #NUTAG_UICC \n
* #NUTAG_CERTIFICATE_DIR \n
* #NUTAG_URL \n
* NUTAG_MEDIA_ENABLE() \n
* NUTAG_SOA_NAME() \n
* NUTAG_PROXY() \n
* NUTAG_URL() \n
* NUTAG_SIPS_URL() \n
* NUTAG_SIP_PARSER() \n
* NUTAG_UICC() \n
* NUTAG_CERTIFICATE_DIR() \n
* all relevant NTATAG_* are passed to NTA
*
* @note
......@@ -459,7 +460,7 @@ int nua_handle_has_active_call(nua_handle_t const *nh)
*
* @retval 0 if no call on hold in operation or operation handle is invalid
* @retval 1 if operation has call on hold, for example nua_invite() or
* nua_update() has been called with #NUTAG_HOLD with != 0 argument.
* nua_update() has been called with NUTAG_HOLD() with != 0 argument.
*
* @par Related tags:
* none
......@@ -700,57 +701,12 @@ void nua_get_hparams(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
NUA_SIGNAL(nh, nua_r_get_params, tag, value);
}
/** Send SIP REGISTER request to the registrar.
*
* Request status will be delivered to the application using #nua_r_register
* event. When successful the registration will be updated periodically. If
* the registrar includes Service-Route header in response, and service
* route is enabled using NUTAG_SERVICE_ROUTE_ENABLE(), the service route
* will be used for initial non-REGISTER requests.
*
* The handle used for registration cannot be used for any other purposes.
*
* @param nh Pointer to operation handle
* @param tag, value, ... List of tagged parameters
*
* @return
* nothing
*
* @par Related tags:
* #NUTAG_REGISTRAR
*
* @par Events:
* #nua_r_register
*/
/* Documented with nua_stack_register() */
void nua_register(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
{
NUA_SIGNAL(nh, nua_r_register, tag, value);
}
/** Unregister.
*
* Send a REGISTER request with expiration time 0. This removes the
* registration from the registrar. If the handle was earlier used
* with nua_register() the periodic updates will be terminated.
*
* If a #SIPTAG_CONTACT_STR with argument "*" is used, the all registrations
* will be removed from the registrar otherwise only the contact address
* belonging to the NUA stack is removed.
*
* @param nh Pointer to operation handle
* @param tag, value, ... List of tagged parameters
*
* @return
* nothing
*
* @par Related tags:
* #NUTAG_REGISTRAR \n
* Tags in <sip_tag.h> except #SIPTAG_EXPIRES or #SIPTAG_EXPIRES_STR
*
* @par Events:
* #nua_r_unregister
*/
void nua_unregister(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
{
NUA_SIGNAL(nh, nua_r_unregister, tag, value);
......@@ -766,9 +722,9 @@ void nua_unregister(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* hung-up with nua_bye().
*
* Optionally
* - uses early media if #NUTAG_EARLY_MEDIA tag is used with non zero value
* - uses early media if NUTAG_EARLY_MEDIA() tag is used with non zero value
* - media parameters can be set by NUTAG_MEDIA_* tags
* - if #NUTAG_MEDIA_ENABLE tag is used with value zero then the soa is
* - if NUTAG_MEDIA_ENABLE() tag is used with value zero then the soa is
* not used and application must create the SDP
* - nua_invite() can be used to change call status:
* - #SOATAG_HOLD tag listing the media put on hold or with value "*" sets
......@@ -820,7 +776,7 @@ void nua_invite(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
*
* Acknowledge a successful response to INVITE request
* with SIP ACK message. This function is need only if
* #NUTAG_AUTOACK parameter has been cleared.
* NUTAG_AUTOACK() parameter has been cleared.
*
* @param nh Pointer to operation handle
* @param tag, value, ... List of tagged parameters
......@@ -966,7 +922,7 @@ void nua_chat(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* nothing
*
* @par Related Tags:
* #NUTAG_URL
* NUTAG_URL()
* Tags in <sip_tag.h>
*
* @par Events:
......@@ -1041,7 +997,7 @@ void nua_notify(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* nothing
*
* @par Related Tags:
* #NUTAG_URL \n
* NUTAG_URL() \n
* #SIPTAG_EVENT or #SIPTAG_EVENT_STR \n
* #SIPTAG_CONTENT_TYPE or SIPTAG_CONTENT_TYPE_STR \n
* #SIPTAG_PAYLOAD or #SIPTAG_PAYLOAD_STR \n
......@@ -1096,7 +1052,7 @@ void nua_terminate(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* nothing
*
* @par Related Tags:
* #NUTAG_URL \n
* NUTAG_URL() \n
* Tags in <sip_tag.h>
*
* @par Events:
......@@ -1124,7 +1080,7 @@ void nua_refer(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* nothing
*
* @par Related Tags:
* #NUTAG_URL \n
* NUTAG_URL() \n
* Tags in <sip_tag.h>
*
* @par Events:
......@@ -1148,7 +1104,7 @@ void nua_publish(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* nothing
*
* @par Related Tags:
* #NUTAG_URL \n
* NUTAG_URL() \n
* Tags in <sip_tag.h>
*
* @par Events:
......@@ -1236,7 +1192,7 @@ void nua_update(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
*
* - 401 / 407 response with www-authenticate header/ proxy-authenticate header
* - application should provide stack with username&password for each realm
* with #NUTAG_AUTH tag
* with NUTAG_AUTH() tag
* - restarts operation
*
* @param nh Pointer to operation handle
......@@ -1246,7 +1202,7 @@ void nua_update(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* nothing
*
* @par Related Tags:
* #NUTAG_AUTH
* NUTAG_AUTH()
*
* @par Events:
* (any operation events)
......@@ -1262,8 +1218,8 @@ void nua_authenticate(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* incoming subscriber launches nua_i_subscription event. Subscriber
* can be authorized in this application callback.
*
* #NUTAG_SUB tag
* #NUTAG_SUBSTATE tag
* NUTAG_SUB() tag
* NUTAG_SUBSTATE() tag
*
* @param nh Pointer to operation handle
* @param tag, value, ... List of tagged parameters
......@@ -1272,8 +1228,8 @@ void nua_authenticate(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* nothing
*
* @par Related Tags:
* #NUTAG_SUB
* #NUTAG_SUBSTATE
* NUTAG_SUB()
* NUTAG_SUBSTATE()
*
* @par Events:
* (any operation events)
......
......@@ -793,7 +793,7 @@ void app_i_message(int status,
} /* app_i_message */
@endcode
@subsection nua_notifier Creating Presence Server
@subsection nua_notifier Creating a Presence Server
@code
......@@ -827,7 +827,7 @@ void app_i_message(int status,
@endcode
After the nua_notifier object -- the presence server -- is created, an
event nua_r_notifier is launched. Status and phrase values of the
event nua_r_notifier is returned. Status and phrase values of the
app_callback function indicate the success of the creation.
Authorization of an incoming subscription (to the local presence
......@@ -2386,20 +2386,6 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
* #NUTAG_SUBSTATE
*/
/** @var nua_event_e::nua_r_register
*
* Answer to outgoing REGISTER.
*
* The REGISTER may be sent explicitly by nua_register() or
* implicitly by NUA state machine.
*
* @param nh operation handle associated with the call
* @param hmagic operation magic associated with the call
* @param sip response to REGISTER request or NULL upon an error
* (error code and message are in status an phrase parameters)
* @param tags empty
*/
/** @var nua_event_e::nua_r_shutdown
*
* Answer to nua_shutdown().
......@@ -2440,17 +2426,6 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
* @param tags empty
*/
/** @var nua_event_e::nua_r_unregister
*
* Answer to outgoing un-REGISTER.
*
* @param nh operation handle associated with the call
* @param hmagic operation magic associated with the call
* @param sip response to REGISTER request or NULL upon an error
* (error code and message are in status and phrase parameters)
* @param tags empty
*/
/** @var nua_event_e::nua_r_unsubscribe
*
* Answer to outgoing un-SUBSCRIBE.
......
......@@ -22,9 +22,8 @@
*
*/
/**
* @file nua_common.c
* @brief
/**@CFILE nua_common.c
* @brief Function common to both stack and application side.
*
* @author Pekka.Pessi@nokia.com
*
......@@ -74,7 +73,8 @@
#include "nua_stack.h"
/** Create an operation handle
/**@internal
* Create an operation handle
*
* Allocates a new operation handle and associated storage.
*
......
......@@ -61,11 +61,13 @@ static void nua_dialog_usage_remove_at(nua_owner_t*, nua_dialog_state_t*,
nua_dialog_usage_t**);
static void nua_dialog_log_usage(nua_owner_t *, nua_dialog_state_t *);
/** UAS tag and route.
/**@internal
* UAS tag and route.
*
* Update dialog tags and route on the UAS side.
*
* @param own dialog owner
* @param ds dialog state
* @param sip SIP message containing response used to update dialog
* @param rtag if true, set remote tag within the leg
*/
......@@ -89,11 +91,13 @@ void nua_dialog_uas_route(nua_owner_t *own,
nta_leg_rtag(ds->ds_leg, sip->sip_from->a_tag);
}
/** UAC tag and route.
/**@internal
* UAC tag and route.
*
* Update dialog tags and route on the UAC side.
*
* @param own dialog owner
* @param ds dialog state
* @param sip SIP message containing response used to update dialog
* @param rtag if true, set remote tag within the leg
*/
......@@ -117,7 +121,7 @@ void nua_dialog_uac_route(nua_owner_t *own,
nta_leg_rtag(ds->ds_leg, sip->sip_to->a_tag);
}
/** Store information from remote endpoint. */
/**@internal Store information from remote endpoint. */
void nua_dialog_store_peer_info(nua_owner_t *own,
nua_dialog_state_t *ds,
sip_t const *sip)
......@@ -177,7 +181,7 @@ void nua_dialog_store_peer_info(nua_owner_t *own,
}
}
/** Get dialog usage slot */
/** @internal Get dialog usage slot. */
nua_dialog_usage_t **
nua_dialog_usage_at(nua_dialog_state_t const *ds,
nua_usage_class const *kind,
......@@ -217,7 +221,7 @@ nua_dialog_usage_at(nua_dialog_state_t const *ds,
return &none;
}
/** Get a dialog usage */
/** @internal Get a dialog usage */
nua_dialog_usage_t *nua_dialog_usage_get(nua_dialog_state_t const *ds,
nua_usage_class const *kind,
sip_event_t const *event)
......@@ -225,7 +229,7 @@ nua_dialog_usage_t *nua_dialog_usage_get(nua_dialog_state_t const *ds,
return *nua_dialog_usage_at(ds, kind, event);
}
/** Get dialog usage name */
/** @internal Get dialog usage name */
char const *nua_dialog_usage_name(nua_dialog_usage_t const *du)
{
if (du == NULL)
......@@ -233,7 +237,7 @@ char const *nua_dialog_usage_name(nua_dialog_usage_t const *du)
return du->du_class->usage_name(du);
}
/** Add dialog usage */
/** @internal Add dialog usage */
nua_dialog_usage_t *nua_dialog_usage_add(nua_owner_t *own,
struct nua_dialog_state *ds,
nua_usage_class const *uclass,
......@@ -290,7 +294,7 @@ nua_dialog_usage_t *nua_dialog_usage_add(nua_owner_t *own,
return NULL;
}
/** Remove dialog usage. */
/** @internal Remove dialog usage. */
void nua_dialog_usage_remove(nua_owner_t *own,
nua_dialog_state_t *ds,
nua_dialog_usage_t *du)
......@@ -308,7 +312,7 @@ void nua_dialog_usage_remove(nua_owner_t *own,
nua_dialog_usage_remove_at(own, ds, at);
}
/** Remove dialog usage.
/** @internal Remove dialog usage.
*
* Zap dialog state (leg, tag and route) if no usages remain.
*/
......@@ -382,7 +386,7 @@ void nua_dialog_log_usage(nua_owner_t *own, nua_dialog_state_t *ds)
}
}
/** Dialog has been terminated. */
/** @internal Dialog has been terminated. */
void nua_dialog_terminated(nua_owner_t *own,
struct nua_dialog_state *ds,
int status,
......@@ -405,7 +409,8 @@ void nua_dialog_terminated(nua_owner_t *own,
}
/** Set refresh value suitably.
/**@internal
* Set refresh value suitably.
*
* The refresh time is set either at half of the @a delta interval or if @a
* delta is less than 5 minutes, 30 seconds before end of interval. $
......@@ -432,7 +437,7 @@ void nua_dialog_usage_set_refresh(nua_dialog_usage_t *du, unsigned delta)
du->du_refresh = target;
}
/** Call the owner operation function */
/** @internal Call the owner operation function. */
void nua_dialog_usage_refresh(nua_owner_t *owner,
nua_dialog_usage_t *du,
sip_time_t now)
......
......@@ -25,7 +25,7 @@
#ifndef NUA_DIALOG_H /** Defined when <nua_dialog.h> has been included. */
#define NUA_DIALOG_H
/**@file nua_dialog.h
/**@IFILE nua_dialog.h
* @brief Dialog and dialog usage handling
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
......
......@@ -244,11 +244,12 @@ void authorize_watcher(nea_server_t *nes,
}
/* ---------------------------------------------------------------------- */
/* Authorization by application */
/* Authorization of watchers by application */
void
nua_stack_authorize(nua_t *nua, nua_handle_t *nh, nua_event_t e,
tagi_t const *tags)
void nua_stack_authorize(nua_t *nua,
nua_handle_t *nh,
nua_event_t e,
tagi_t const *tags)
{
nea_sub_t *sub = NULL;
nea_state_t state = nea_extended;
......@@ -268,13 +269,11 @@ nua_stack_authorize(nua_t *nua, nua_handle_t *nh, nua_event_t e,
return;
}
/** Shutdown notifier object */
int
nh_notifier_shutdown(nua_handle_t *nh, nea_event_t *ev,
tag_type_t t, tag_value_t v, ...)
/** @internal Shutdown notifier object */
int nh_notifier_shutdown(nua_handle_t *nh,
nea_event_t *ev,
tag_type_t t,
tag_value_t v, ...)
{
nea_server_t *nes = nh->nh_notifier;
nea_subnode_t const **subs;
......@@ -310,9 +309,11 @@ nh_notifier_shutdown(nua_handle_t *nh, nea_event_t *ev,
}
/** Terminate notifier. */
void
nua_stack_terminate(nua_t *nua, nua_handle_t *nh, nua_event_t e, tagi_t const *tags)
/** @internal Terminate notifier. */
void nua_stack_terminate(nua_t *nua,
nua_handle_t *nh,
nua_event_t e,
tagi_t const *tags)
{
sip_event_t const *event = NULL;
sip_content_type_t const *ct = NULL;
......
......@@ -22,8 +22,8 @@
*
*/
/**@CFILE nua_message.c
* @brief OPTIONS method
/**@CFILE nua_options.c
* @brief Implementation of OPTIONS method
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
*
......
This diff is collapsed.
......@@ -777,7 +777,7 @@ static int
process_cancel(nua_handle_t *, nta_incoming_t *, sip_t const *),
process_timeout(nua_handle_t *, nta_incoming_t *);
/** Process incoming INVITE. */
/** @internal Process incoming INVITE. */
int nua_stack_process_invite(nua_t *nua,
nua_handle_t *nh0,
nta_incoming_t *irq,
......@@ -799,7 +799,7 @@ int nua_stack_process_invite(nua_t *nua,
return process_invite2(nua, nh, irq, (sip_t *)sip);
}
/** Preprocess incoming invite - sure we have a valid request. */
/** @internal Preprocess incoming invite - sure we have a valid request. */
static
int process_invite1(nua_t *nua,
nua_handle_t **return_nh,
......@@ -924,7 +924,7 @@ int process_invite1(nua_t *nua,
return 0;
}
/** Process incoming invite - initiate media, etc. */
/** @internal Process incoming invite - initiate media, etc. */
static
int process_invite2(nua_t *nua,
nua_handle_t *nh,
......@@ -989,11 +989,12 @@ int process_invite2(nua_t *nua,
return 0;
}
/** Respond to an INVITE request.
/** @internal Respond to an INVITE request.
*
* XXX - use tags to indicate when to use reliable responses.
* XXX - change prototype.
*/
static
void respond_to_invite(nua_t *nua, nua_handle_t *nh,
int status, char const *phrase,
tagi_t const *tags)
......@@ -1184,7 +1185,7 @@ void respond_to_invite(nua_t *nua, nua_handle_t *nh,
}
/** Process ACK or CANCEL or timeout (no ACK) for incoming INVITE */
/** @internal Process ACK or CANCEL or timeout (no ACK) for incoming INVITE */
static
int process_ack_or_cancel(nua_handle_t *nh,
nta_incoming_t *irq,
......@@ -1209,7 +1210,7 @@ int process_ack_or_cancel(nua_handle_t *nh,
return retval;
}
/** Process PRACK or (timeout from 100rel) */
/** @internal Process PRACK or (timeout from 100rel) */
static
int process_prack(nua_handle_t *nh,
nta_reliable_t *rel,
......
......@@ -400,7 +400,7 @@ void
int nh_notifier_shutdown(nua_handle_t *nh, nea_event_t *ev,
tag_type_t t, tag_value_t v, ...);
/** Send an event to the application. */
/** @internal Send an event to the application. */
int nua_stack_event(nua_t *nua, nua_handle_t *nh, msg_t *msg,
nua_event_t event, int status, char const *phrase,
tag_type_t tag, tag_value_t value, ...)
......@@ -603,7 +603,8 @@ void nua_stack_signal(nua_t *nua, su_msg_r msg, nua_event_data_t *e)
static int nh_call_pending(nua_handle_t *nh, sip_time_t time);
/** Timer routine.
/**@internal
* Timer routine.
*
* Go through all active handles and execute pending tasks
*/
......@@ -675,7 +676,7 @@ int nh_call_pending(nua_handle_t *nh, sip_time_t now)
/* ====================================================================== */
/** Shut down stack. */
/** @internal Shut down stack. */
void nua_stack_shutdown(nua_t *nua)
{
nua_handle_t *nh, *nh_next;
......@@ -1238,7 +1239,7 @@ int nua_stack_get_params(nua_t *nua, nua_handle_t *nh, nua_event_t e,
/* ---------------------------------------------------------------------- */
/** Create a handle */
/** @internal Create a handle */
nua_handle_t *nh_create(nua_t *nua, tag_type_t tag, tag_value_t value, ...)
{
ta_list ta;
......@@ -1258,7 +1259,7 @@ nua_handle_t *nh_create(nua_t *nua, tag_type_t tag, tag_value_t value, ...)
return nh;
}
/** Append an handle to the list of handles */
/** @internal Append an handle to the list of handles */
void nh_append(nua_t *nua, nua_handle_t *nh)
{
nh->nh_next = NULL;
......@@ -1298,7 +1299,7 @@ void nua_stack_destroy_handle(nua_t *nua, nua_handle_t *nh, tagi_t const *tags)
#define nh_is_inserted(nh) ((nh)->nh_prev != NULL)
/** Remove a handle from list of handles */
/** @internal Remove a handle from list of handles */
static
void nh_remove(nua_t *nua, nua_handle_t *nh)
{
......@@ -1368,7 +1369,8 @@ void nua_creq_deinit(struct nua_client_request *cr, nta_outgoing_t *orq)
/* ======================================================================== */
/** Initialize handle Allow and authentication info.
/**@internal
* Initialize handle Allow and authentication info.
*
* @retval -1 upon an error
* @retval 0 when successful
......@@ -1438,7 +1440,7 @@ int nua_stack_init_handle(nua_t *nua, nua_handle_t *nh,
return 0;
}
/** Create a handle for processing incoming request */
/** @internal Create a handle for processing incoming request */
nua_handle_t *nua_stack_incoming_handle(nua_t *nua,
nta_incoming_t *irq,
sip_t const *sip,
......@@ -1497,7 +1499,7 @@ nua_handle_t *nua_stack_incoming_handle(nua_t *nua,
}
/** Add authorization data */
/** @internal Add authorization data */
int nh_authorize(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
{
int retval = 0;
......@@ -1526,7 +1528,8 @@ int nh_authorize(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
return retval;
}
/** Collect challenges from response.
/**@internal
* Collect challenges from response.
*
* @return Number of updated challenges, 0 if no updates found.
* @retval -1 upon error.
......@@ -1552,19 +1555,22 @@ int nh_challenge(nua_handle_t *nh, sip_t const *sip)
return server + proxy;
}
/** Create request message.
/**@internal
* Create a request message.
*
* @param nua
* @param nh
* @param cr
* @param restart
* @param method
* @param name
* @param tag @a value list of tag-value pairs
* @param tag, value, ... list of tag-value pairs
*/
msg_t *nua_creq_msg(nua_t *nua, nua_handle_t *nh,
struct nua_client_request *cr,
int restart,
sip_method_t method, char const *name,
tag_type_t tag, tag_value_t value, ...)
struct nua_client_request *cr,
int restart,
sip_method_t method, char const *name,
tag_type_t tag, tag_value_t value, ...)
{
struct nua_dialog_state *ds = nh->nh_ds;
msg_t *msg;
......@@ -1761,14 +1767,15 @@ msg_t *nua_creq_msg(nua_t *nua, nua_handle_t *nh,
return msg;
}
/** Create response message.
/**@internal
* Create a response message.
*
* @param nua
* @param nh
* @param irq
* @param status
* @param phrase
* @param tag, @a value, ... list of tag-value pairs
* @param tag, value, ... list of tag-value pairs
*/
msg_t *nh_make_response(nua_t *nua, nua_handle_t *nh,
nta_incoming_t *irq,
......@@ -1837,7 +1844,8 @@ nua_stack_method(nua_t *nua, nua_handle_t *nh, nua_event_t e,
return UA_EVENT1(e, SIP_501_NOT_IMPLEMENTED);
}
/**Relay response message to the application.
/**@internal
* Relay response message to the application.
*
* If handle has already been marked as destroyed by nua_handle_destroy(),
* release the handle with nh_destroy().
......@@ -1928,7 +1936,7 @@ int nua_creq_restart_with(nua_handle_t *nh,
}
/** Save operation until it can be restarted */
/** @internal Save operation until it can be restarted */
int nua_creq_save_restart(nua_handle_t *nh,
struct nua_client_request *cr,
nta_outgoing_t *orq,
......@@ -1953,7 +1961,8 @@ int nua_creq_save_restart(nua_handle_t *nh,
}
/** Check response, return true if we can restart the request.
/**@internal
* Check response, return true if we can restart the request.
*
*/
int nua_creq_check_restart(nua_handle_t *nh,
......@@ -2073,7 +2082,7 @@ int nua_creq_check_restart(nua_handle_t *nh,
return 0;
}
/** Restart a request */
/** @internal Restart a request */
int nua_creq_restart(nua_handle_t *nh,
struct nua_client_request *cr,
nta_response_f *cb,
......
......@@ -24,7 +24,7 @@
#ifndef NUA_STACK_H /** Defined when <nua_stack.h> has been included. */
#define NUA_STACK_H
/**@file nua_stack.h
/**@IFILE nua_stack.h
* @brief Sofia-SIP User Agent Engine - internal stack interface
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
......@@ -88,16 +88,6 @@ enum nh_kind {
nh_has_streaming
};
enum nh_oa_event {
nua_sdp_none,
nua_sdp_offer_sent, /**< O/A-1 offer sent */
nua_sdp_answer_recv, /**< O/A-2 answer received */
nua_sdp_offer_recv, /**< O/A-3 offer received */
nua_sdp_answer_sent /**< O/A-4 answer sent */
};
typedef struct nua_chat_s nua_chat_t;
typedef struct nua_client_request nua_client_request_t;
typedef struct nua_server_request nua_server_request_t;
......
......@@ -424,7 +424,7 @@ pending_unsubscribe(nua_handle_t *nh, nua_dialog_usage_t *du, sip_time_t now)
nua_dialog_usage_remove(nh, nh->nh_ds, du);
}
/** Process incoming SUBSCRIBE. */
/** @internal Process incoming SUBSCRIBE. */
int nua_stack_process_subsribe(nua_t *nua,
nua_handle_t *nh,
nta_incoming_t *irq,
......@@ -663,7 +663,7 @@ static int process_response_to_notify(nua_handle_t *nh,
return nua_stack_process_response(nh, nh->nh_cr, orq, sip, TAG_END());
}
/** Process incoming NOTIFY. */
/** @internal Process incoming NOTIFY. */
int nua_stack_process_notify(nua_t *nua,
nua_handle_t *nh,
nta_incoming_t *irq,
......@@ -906,7 +906,7 @@ static int process_response_to_refer(nua_handle_t *nh,
return nua_stack_process_response(nh, cr, orq, sip, TAG_END());
}
/** Process incoming REFER. */
/** @internal Process incoming REFER. */
int nua_stack_process_refer(nua_t *nua,
nua_handle_t *nh,
nta_incoming_t *irq,
......
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