libeXosip2  3.1.0
Functions
eXosip2 authentication API

Functions

int eXosip_add_authentication_info (const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm)
 
int eXosip_clear_authentication_info (void)
 
int eXosip_default_action (eXosip_event_t *je)
 
void eXosip_automatic_refresh (void)
 
void eXosip_automatic_action (void)
 
int eXosip_insubscription_automatic (eXosip_event_t *evt)
 
int eXosip_generate_random (char *buf, int buf_size)
 

Detailed Description

Function Documentation

int eXosip_add_authentication_info ( const char *  username,
const char *  userid,
const char *  passwd,
const char *  ha1,
const char *  realm 
)

Add authentication credentials. These are used when an outgoing request comes back with an authorization required response.

Parameters
usernameusername
useridlogin (usually equals the username)
passwdpassword
ha1currently ignored
realmrealm within which credentials apply, or NULL to apply credentials to unrecognized realms
int eXosip_clear_authentication_info ( void  )

Clear all authentication credentials stored in eXosip.

int eXosip_default_action ( eXosip_event_t je)

Initiate some default actions:

Retry with credentials upon reception of 401/407. Retry with Contact header upon reception of 3xx request.

void eXosip_automatic_refresh ( void  )

Refresh REGISTER and SUBSCRIBE before the expiration delay.

void eXosip_automatic_action ( void  )

Initiate some automatic actions:

Retry with credentials upon reception of 401/407. Refresh REGISTER and SUBSCRIBE before the expiration delay. Retry with Contact header upon reception of 3xx request.

int eXosip_insubscription_automatic ( eXosip_event_t evt)

Automatic internal handling of known package.

Parameters
evtevent related to an incoming subscription.
int eXosip_generate_random ( char *  buf,
int  buf_size 
)

Generate random string:

Parameters
bufdestination buffer for random string.
buf_sizesize of destination buffer