diff options
| author | Benny Prijono <bennylp@teluu.com> | 2006-06-17 04:08:30 +0000 |
|---|---|---|
| committer | Benny Prijono <bennylp@teluu.com> | 2006-06-17 04:08:30 +0000 |
| commit | 3034f9480369cb8083cd625b358354b4618cd985 (patch) | |
| tree | 93b19f8af9d64b7916825c9ee9a99dc88586cd8a /pjsip/include/pjsip/sip_ua_layer.h | |
| parent | edf38f478920a443dc29cf3d638e6b27d7a838e6 (diff) | |
Modifications all over the place, but mainly only to update Doxygen documentation
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@515 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjsip/include/pjsip/sip_ua_layer.h')
| -rw-r--r-- | pjsip/include/pjsip/sip_ua_layer.h | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/pjsip/include/pjsip/sip_ua_layer.h b/pjsip/include/pjsip/sip_ua_layer.h index 4c62bec6..ca6db080 100644 --- a/pjsip/include/pjsip/sip_ua_layer.h +++ b/pjsip/include/pjsip/sip_ua_layer.h @@ -29,20 +29,34 @@ PJ_BEGIN_DECL /** - * @defgroup PJSUA SIP User Agent Stack + * @defgroup PJSIP_UA Base User Agent Layer/Common Dialog Layer + * @ingroup PJSIP + * @brief Dialog management. + * + * This module provides basic dialog management, which is used by higher + * layer dialog usages such as INVITE sessions and SIP Event Subscription + * framework (RFC 3265). Application should link with <b>pjsip-core</b> + * library to use this base UA layer. The base UA layer module is initialized + * with #pjsip_ua_init_module(). */ /** * @defgroup PJSUA_UA SIP User Agent Module - * @ingroup PJSUA + * @ingroup PJSIP_UA + * @brief Provides dialog management. * @{ - * \brief - * User Agent manages the interactions between application and SIP dialogs. + * + * Application MUST initialize the user agent layer module by calling + * #pjsip_ua_init_module() before using any of the dialog API, and link + * the application with with <b>pjsip-core</b> library. */ /** User agent initialization parameter. */ typedef struct pjsip_ua_init_param { + /** Callback to be called when the UA layer detects that outgoing + * dialog has forked. + */ pjsip_dialog* (*on_dlg_forked)(pjsip_dialog *first_set, pjsip_rx_data *res); } pjsip_ua_init_param; @@ -90,6 +104,11 @@ PJ_DEF(void) pjsip_ua_dump(pj_bool_t detail); PJ_DECL(pjsip_endpoint*) pjsip_ua_get_endpt(pjsip_user_agent *ua); +/** + * @} + */ + + /* * Internal (called by sip_dialog.c). */ @@ -100,10 +119,6 @@ PJ_DECL(pj_status_t) pjsip_ua_unregister_dlg(pjsip_user_agent *ua, pjsip_dialog *dlg ); -/** - * @} - */ - PJ_END_DECL |