.TH "eXosip2 authentication API" 3 "Sun Jun 24 2012" "Version 3.1.0" "libeXosip2" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eXosip2 authentication API \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBeXosip_add_authentication_info\fP (const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm)"
.br
.ti -1c
.RI "int \fBeXosip_clear_authentication_info\fP (void)"
.br
.ti -1c
.RI "int \fBeXosip_default_action\fP (\fBeXosip_event_t\fP *je)"
.br
.ti -1c
.RI "void \fBeXosip_automatic_refresh\fP (void)"
.br
.ti -1c
.RI "void \fBeXosip_automatic_action\fP (void)"
.br
.ti -1c
.RI "int \fBeXosip_insubscription_automatic\fP (\fBeXosip_event_t\fP *evt)"
.br
.ti -1c
.RI "int \fBeXosip_generate_random\fP (char *buf, int buf_size)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "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\&.
.PP
\fBParameters:\fP
.RS 4
\fIusername\fP username 
.br
\fIuserid\fP login (usually equals the username) 
.br
\fIpasswd\fP password 
.br
\fIha1\fP currently ignored 
.br
\fIrealm\fP realm within which credentials apply, or NULL to apply credentials to unrecognized realms 
.RE
.PP

.SS "int eXosip_clear_authentication_info (void)"
Clear all authentication credentials stored in eXosip\&. 
.SS "int eXosip_default_action (\fBeXosip_event_t\fP *je)"
Initiate some default actions:
.PP
Retry with credentials upon reception of 401/407\&. Retry with Contact header upon reception of 3xx request\&. 
.SS "void eXosip_automatic_refresh (void)"
Refresh REGISTER and SUBSCRIBE before the expiration delay\&. 
.SS "void eXosip_automatic_action (void)"
Initiate some automatic actions:
.PP
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\&. 
.SS "int eXosip_insubscription_automatic (\fBeXosip_event_t\fP *evt)"
Automatic internal handling of known package\&.
.PP
\fBParameters:\fP
.RS 4
\fIevt\fP event related to an incoming subscription\&. 
.RE
.PP

.SS "int eXosip_generate_random (char *buf, intbuf_size)"
Generate random string:
.PP
\fBParameters:\fP
.RS 4
\fIbuf\fP destination buffer for random string\&. 
.br
\fIbuf_size\fP size of destination buffer 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for libeXosip2 from the source code\&.