.TH "eXosip2_authentication" 3 "Thu Dec 15 2016" "Version 4.1.0" "libeXosip2" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eXosip2_authentication \- eXosip2 authentication API
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBeXosip_add_authentication_info\fP (struct eXosip_t *excontext, const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm)"
.br
.ti -1c
.RI "int \fBeXosip_remove_authentication_info\fP (struct eXosip_t *excontext, const char *username, const char *realm)"
.br
.ti -1c
.RI "int \fBeXosip_clear_authentication_info\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "int \fBeXosip_default_action\fP (struct eXosip_t *excontext, \fBeXosip_event_t\fP *je)"
.br
.ti -1c
.RI "void \fBeXosip_automatic_refresh\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "void \fBeXosip_automatic_action\fP (struct eXosip_t *excontext)"
.br
.ti -1c
.RI "int \fBeXosip_insubscription_automatic\fP (struct eXosip_t *excontext, \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 (struct eXosip_t * excontext, 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
\fIexcontext\fP eXosip_t instance\&. 
.br
\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_remove_authentication_info (struct eXosip_t * excontext, const char * username, const char * realm)"
Remove authentication credentials\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIusername\fP username 
.br
\fIrealm\fP realm must be exact same arg as for eXosip_add_authentication_info 
.RE
.PP

.SS "int eXosip_clear_authentication_info (struct eXosip_t * excontext)"
Clear all authentication credentials stored in eXosip
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.RE
.PP

.SS "int eXosip_default_action (struct eXosip_t * excontext, \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\&.
.PP
Useful & required when \fBeXosip_automatic_action()\fP can't do the automatic action: 1/ if you receive a 401 or 407 for BYE (event EXOSIP_CALL_MESSAGE_REQUESTFAILURE)\&. 2/ if you receive 401 or 407 for any sip request outside of dialog (EXOSIP_MESSAGE_REQUESTFAILURE)
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIje\fP event to work on\&. 
.RE
.PP

.SS "void eXosip_automatic_refresh (struct eXosip_t * excontext)"
Initiate some automatic actions:
.PP
Refresh REGISTER and SUBSCRIBE before the expiration delay\&. Those actions are already done by \fBeXosip_automatic_action()\fP; Prefer eXosip_automatic_action instead of this method\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.RE
.PP

.SS "void eXosip_automatic_action (struct eXosip_t * excontext)"
Initiate some automatic actions:
.PP
Retry with credentials upon reception of 401/407\&. Retry with higher Session-Expires upon reception of 422\&. Refresh REGISTER and SUBSCRIBE before the expiration delay\&. Retry with Contact header upon reception of 3xx request\&. Send automatic UPDATE for session-timer feature\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.RE
.PP

.SS "int eXosip_insubscription_automatic (struct eXosip_t * excontext, \fBeXosip_event_t\fP * evt)"
Automatic internal handling of dialog package\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIevt\fP Incoming SUBSCRIBE for dialog package\&. 
.RE
.PP

.SS "int eXosip_generate_random (char * buf, int buf_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\&.