Doc: somes details on user registration functions

This commit is contained in:
Mathieu Parent 2011-02-23 00:31:26 +01:00
parent 0dcdd78cb5
commit f202328eff
1 changed files with 24 additions and 0 deletions

View File

@ -2227,9 +2227,33 @@ SWITCH_DECLARE(const char *) switch_core_banner(void);
SWITCH_DECLARE(switch_bool_t) switch_core_session_in_thread(switch_core_session_t *session);
SWITCH_DECLARE(uint32_t) switch_default_ptime(const char *name, uint32_t number);
/*!
\brief Add user registration
\param [in] user
\param [in] realm
\param [in] token
\param [in] url - a freeswitch dial string
\param [in] expires
\param [in] network_ip
\param [in] network_port
\param [in] network_proto - one of tls, tcp, udp
\param [out] err - Error if it exists
*/
SWITCH_DECLARE(switch_status_t) switch_core_add_registration(const char *user, const char *realm, const char *token, const char *url, uint32_t expires,
const char *network_ip, const char *network_port, const char *network_proto);
/*!
\brief Delete user registration
\param [in] user
\param [in] realm
\param [in] token
\param [out] err - Error if it exists
*/
SWITCH_DECLARE(switch_status_t) switch_core_del_registration(const char *user, const char *realm, const char *token);
/*!
\brief Expire user registrations
\param [in] force delete all registrations
\param [out] err - Error if it exists
*/
SWITCH_DECLARE(switch_status_t) switch_core_expire_registration(int force);
SWITCH_END_EXTERN_C