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

.in +1c
.ti -1c
.RI "struct \fBeXosip_event\fP"
.br
.ti -1c
.RI "struct \fBeXosip_tls_credentials_s\fP"
.br
.ti -1c
.RI "struct \fBeXosip_tls_ctx_s\fP"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBeXosip_event_type\fP { \fBEXOSIP_REGISTRATION_NEW\fP, \fBEXOSIP_REGISTRATION_SUCCESS\fP, \fBEXOSIP_REGISTRATION_FAILURE\fP, \fBEXOSIP_REGISTRATION_REFRESHED\fP, \fBEXOSIP_REGISTRATION_TERMINATED\fP, \fBEXOSIP_CALL_INVITE\fP, \fBEXOSIP_CALL_REINVITE\fP, \fBEXOSIP_CALL_NOANSWER\fP, \fBEXOSIP_CALL_PROCEEDING\fP, \fBEXOSIP_CALL_RINGING\fP, \fBEXOSIP_CALL_ANSWERED\fP, \fBEXOSIP_CALL_REDIRECTED\fP, \fBEXOSIP_CALL_REQUESTFAILURE\fP, \fBEXOSIP_CALL_SERVERFAILURE\fP, \fBEXOSIP_CALL_GLOBALFAILURE\fP, \fBEXOSIP_CALL_ACK\fP, \fBEXOSIP_CALL_CANCELLED\fP, \fBEXOSIP_CALL_TIMEOUT\fP, \fBEXOSIP_CALL_MESSAGE_NEW\fP, \fBEXOSIP_CALL_MESSAGE_PROCEEDING\fP, \fBEXOSIP_CALL_MESSAGE_ANSWERED\fP, \fBEXOSIP_CALL_MESSAGE_REDIRECTED\fP, \fBEXOSIP_CALL_MESSAGE_REQUESTFAILURE\fP, \fBEXOSIP_CALL_MESSAGE_SERVERFAILURE\fP, \fBEXOSIP_CALL_MESSAGE_GLOBALFAILURE\fP, \fBEXOSIP_CALL_CLOSED\fP, \fBEXOSIP_CALL_RELEASED\fP, \fBEXOSIP_MESSAGE_NEW\fP, \fBEXOSIP_MESSAGE_PROCEEDING\fP, \fBEXOSIP_MESSAGE_ANSWERED\fP, \fBEXOSIP_MESSAGE_REDIRECTED\fP, \fBEXOSIP_MESSAGE_REQUESTFAILURE\fP, \fBEXOSIP_MESSAGE_SERVERFAILURE\fP, \fBEXOSIP_MESSAGE_GLOBALFAILURE\fP, \fBEXOSIP_SUBSCRIPTION_UPDATE\fP, \fBEXOSIP_SUBSCRIPTION_CLOSED\fP, \fBEXOSIP_SUBSCRIPTION_NOANSWER\fP, \fBEXOSIP_SUBSCRIPTION_PROCEEDING\fP, \fBEXOSIP_SUBSCRIPTION_ANSWERED\fP, \fBEXOSIP_SUBSCRIPTION_REDIRECTED\fP, \fBEXOSIP_SUBSCRIPTION_REQUESTFAILURE\fP, \fBEXOSIP_SUBSCRIPTION_SERVERFAILURE\fP, \fBEXOSIP_SUBSCRIPTION_GLOBALFAILURE\fP, \fBEXOSIP_SUBSCRIPTION_NOTIFY\fP, \fBEXOSIP_SUBSCRIPTION_RELEASED\fP, \fBEXOSIP_IN_SUBSCRIPTION_NEW\fP, \fBEXOSIP_IN_SUBSCRIPTION_RELEASED\fP, \fBEXOSIP_NOTIFICATION_NOANSWER\fP, \fBEXOSIP_NOTIFICATION_PROCEEDING\fP, \fBEXOSIP_NOTIFICATION_ANSWERED\fP, \fBEXOSIP_NOTIFICATION_REDIRECTED\fP, \fBEXOSIP_NOTIFICATION_REQUESTFAILURE\fP, \fBEXOSIP_NOTIFICATION_SERVERFAILURE\fP, \fBEXOSIP_NOTIFICATION_GLOBALFAILURE\fP, \fBEXOSIP_EVENT_COUNT\fP }"
.br
.ti -1c
.RI "enum \fBeXosip_tls_ctx_error\fP { \fBTLS_OK\fP =  0, \fBTLS_ERR_NO_RAND\fP =  -1, \fBTLS_ERR_NO_DH_PARAM\fP =  -2, \fBTLS_ERR_NO_PW\fP =  -3, \fBTLS_ERR_NO_ROOT_CA\fP =  -4, \fBTLS_ERR_MISSING_AUTH_PART\fP =  -5 }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBeXosip_event_free\fP (\fBeXosip_event_t\fP *je)"
.br
.ti -1c
.RI "\fBeXosip_event_t\fP * \fBeXosip_event_wait\fP (int tv_s, int tv_ms)"
.br
.ti -1c
.RI "\fBeXosip_event_t\fP * \fBeXosip_event_get\fP (void)"
.br
.ti -1c
.RI "int \fBeXosip_event_geteventsocket\fP (void)"
.br
.ti -1c
.RI "\fBeXosip_tls_ctx_error\fP \fBeXosip_set_tls_ctx\fP (\fBeXosip_tls_ctx_t\fP *ctx)"
.br
.ti -1c
.RI "\fBeXosip_tls_ctx_error\fP \fBeXosip_tls_use_server_certificate\fP (const char *local_certificate_cn)"
.br
.ti -1c
.RI "\fBeXosip_tls_ctx_error\fP \fBeXosip_tls_use_client_certificate\fP (const char *local_certificate_cn)"
.br
.ti -1c
.RI "\fBeXosip_tls_ctx_error\fP \fBeXosip_tls_verify_certificate\fP (int _tls_verify_client_certificate)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBeXosip_event_type\fP"
Structure for event type description 
.PP
\fBEnumerator: \fP
.in +1c
.TP
\fB\fIEXOSIP_REGISTRATION_NEW \fP\fP
announce new registration\&. 
.TP
\fB\fIEXOSIP_REGISTRATION_SUCCESS \fP\fP
user is successfully registred\&. 
.TP
\fB\fIEXOSIP_REGISTRATION_FAILURE \fP\fP
user is not registred\&. 
.TP
\fB\fIEXOSIP_REGISTRATION_REFRESHED \fP\fP
registration has been refreshed\&. 
.TP
\fB\fIEXOSIP_REGISTRATION_TERMINATED \fP\fP
UA is not registred any more\&. 
.TP
\fB\fIEXOSIP_CALL_INVITE \fP\fP
announce a new call 
.TP
\fB\fIEXOSIP_CALL_REINVITE \fP\fP
announce a new INVITE within call 
.TP
\fB\fIEXOSIP_CALL_NOANSWER \fP\fP
announce no answer within the timeout 
.TP
\fB\fIEXOSIP_CALL_PROCEEDING \fP\fP
announce processing by a remote app 
.TP
\fB\fIEXOSIP_CALL_RINGING \fP\fP
announce ringback 
.TP
\fB\fIEXOSIP_CALL_ANSWERED \fP\fP
announce start of call 
.TP
\fB\fIEXOSIP_CALL_REDIRECTED \fP\fP
announce a redirection 
.TP
\fB\fIEXOSIP_CALL_REQUESTFAILURE \fP\fP
announce a request failure 
.TP
\fB\fIEXOSIP_CALL_SERVERFAILURE \fP\fP
announce a server failure 
.TP
\fB\fIEXOSIP_CALL_GLOBALFAILURE \fP\fP
announce a global failure 
.TP
\fB\fIEXOSIP_CALL_ACK \fP\fP
ACK received for 200ok to INVITE 
.TP
\fB\fIEXOSIP_CALL_CANCELLED \fP\fP
announce that call has been cancelled 
.TP
\fB\fIEXOSIP_CALL_TIMEOUT \fP\fP
announce that call has failed 
.TP
\fB\fIEXOSIP_CALL_MESSAGE_NEW \fP\fP
announce new incoming request\&. 
.TP
\fB\fIEXOSIP_CALL_MESSAGE_PROCEEDING \fP\fP
announce a 1xx for request\&. 
.TP
\fB\fIEXOSIP_CALL_MESSAGE_ANSWERED \fP\fP
announce a 200ok 
.TP
\fB\fIEXOSIP_CALL_MESSAGE_REDIRECTED \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_CALL_MESSAGE_REQUESTFAILURE \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_CALL_MESSAGE_SERVERFAILURE \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_CALL_MESSAGE_GLOBALFAILURE \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_CALL_CLOSED \fP\fP
a BYE was received for this call 
.TP
\fB\fIEXOSIP_CALL_RELEASED \fP\fP
call context is cleared\&. 
.TP
\fB\fIEXOSIP_MESSAGE_NEW \fP\fP
announce new incoming request\&. 
.TP
\fB\fIEXOSIP_MESSAGE_PROCEEDING \fP\fP
announce a 1xx for request\&. 
.TP
\fB\fIEXOSIP_MESSAGE_ANSWERED \fP\fP
announce a 200ok 
.TP
\fB\fIEXOSIP_MESSAGE_REDIRECTED \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_MESSAGE_REQUESTFAILURE \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_MESSAGE_SERVERFAILURE \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_MESSAGE_GLOBALFAILURE \fP\fP
announce a failure\&. 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_UPDATE \fP\fP
announce incoming SUBSCRIBE\&. 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_CLOSED \fP\fP
announce end of subscription\&. 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_NOANSWER \fP\fP
announce no answer 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_PROCEEDING \fP\fP
announce a 1xx 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_ANSWERED \fP\fP
announce a 200ok 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_REDIRECTED \fP\fP
announce a redirection 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_REQUESTFAILURE \fP\fP
announce a request failure 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_SERVERFAILURE \fP\fP
announce a server failure 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_GLOBALFAILURE \fP\fP
announce a global failure 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_NOTIFY \fP\fP
announce new NOTIFY request 
.TP
\fB\fIEXOSIP_SUBSCRIPTION_RELEASED \fP\fP
call context is cleared\&. 
.TP
\fB\fIEXOSIP_IN_SUBSCRIPTION_NEW \fP\fP
announce new incoming SUBSCRIBE\&. 
.TP
\fB\fIEXOSIP_IN_SUBSCRIPTION_RELEASED \fP\fP
announce end of subscription\&. 
.TP
\fB\fIEXOSIP_NOTIFICATION_NOANSWER \fP\fP
announce no answer 
.TP
\fB\fIEXOSIP_NOTIFICATION_PROCEEDING \fP\fP
announce a 1xx 
.TP
\fB\fIEXOSIP_NOTIFICATION_ANSWERED \fP\fP
announce a 200ok 
.TP
\fB\fIEXOSIP_NOTIFICATION_REDIRECTED \fP\fP
announce a redirection 
.TP
\fB\fIEXOSIP_NOTIFICATION_REQUESTFAILURE \fP\fP
announce a request failure 
.TP
\fB\fIEXOSIP_NOTIFICATION_SERVERFAILURE \fP\fP
announce a server failure 
.TP
\fB\fIEXOSIP_NOTIFICATION_GLOBALFAILURE \fP\fP
announce a global failure 
.TP
\fB\fIEXOSIP_EVENT_COUNT \fP\fP
MAX number of events 
.SS "enum \fBeXosip_tls_ctx_error\fP"
An enumeration which describes the error which can occur while setting the eXosip_tls_ctx 
.PP
\fBEnumerator: \fP
.in +1c
.TP
\fB\fITLS_OK \fP\fP
yippieh, everything is fine :) 
.TP
\fB\fITLS_ERR_NO_RAND \fP\fP
no absolute path to the random file was specified 
.TP
\fB\fITLS_ERR_NO_DH_PARAM \fP\fP
no absolute path to the diifie hellman file was specified 
.TP
\fB\fITLS_ERR_NO_PW \fP\fP
no password was specified 
.TP
\fB\fITLS_ERR_NO_ROOT_CA \fP\fP
no absolute path to the rootCA file was specified 
.TP
\fB\fITLS_ERR_MISSING_AUTH_PART \fP\fP
something is missing: the private key or the certificate 
.SH "Function Documentation"
.PP 
.SS "void eXosip_event_free (\fBeXosip_event_t\fP *je)"
Free resource in an eXosip event\&.
.PP
\fBParameters:\fP
.RS 4
\fIje\fP event to work on\&. 
.RE
.PP

.SS "\fBeXosip_event_t\fP* eXosip_event_wait (inttv_s, inttv_ms)"
Wait for an eXosip event\&.
.PP
\fBParameters:\fP
.RS 4
\fItv_s\fP timeout value (seconds)\&. 
.br
\fItv_ms\fP timeout value (mseconds)\&. 
.RE
.PP

.SS "\fBeXosip_event_t\fP* eXosip_event_get (void)"
Wait for next eXosip event\&. 
.SS "int eXosip_event_geteventsocket (void)"
This socket receive some data yhen an event happens internally\&. NOTE: you must call eXosip_event_wait until there is no more events in the fifo\&. 
.SS "\fBeXosip_tls_ctx_error\fP eXosip_set_tls_ctx (\fBeXosip_tls_ctx_t\fP *ctx)"
sets the parameters for the TLS context, which is used for encrypted connections
.PP
\fBParameters:\fP
.RS 4
\fIctx,IN\fP a struct which holds the necessary parameters
.RE
.PP
\fBReturns:\fP
.RS 4
the eXosip_tls_ctx_error code 
.RE
.PP

.SS "\fBeXosip_tls_ctx_error\fP eXosip_tls_use_server_certificate (const char *local_certificate_cn)"
Select by CN name the server certificate from OS store\&.
.PP
12/11/2009 -> implemented only for 'Windows Certificate Store'
.PP
\fBParameters:\fP
.RS 4
\fIlocal_certificate_cn\fP CN name of the certificate to send on incoming connection
.RE
.PP
\fBReturns:\fP
.RS 4
the eXosip_tls_ctx_error code 
.RE
.PP

.SS "\fBeXosip_tls_ctx_error\fP eXosip_tls_use_client_certificate (const char *local_certificate_cn)"
Select by CN name the client certificate from OS store\&.
.PP
31/1/2011 -> implemented only for 'Windows Certificate Store'
.PP
\fBParameters:\fP
.RS 4
\fIlocal_certificate_cn\fP CN name of the certificate to send on outgoing connection
.RE
.PP
\fBReturns:\fP
.RS 4
the eXosip_tls_ctx_error code 
.RE
.PP

.SS "\fBeXosip_tls_ctx_error\fP eXosip_tls_verify_certificate (int_tls_verify_client_certificate)"
.PP
.nf
Configure to accept/reject self signed and expired certificates.
.fi
.PP
 NOTE: default is to accept (0) 
.PP
.nf
@param _tls_verify_client_certificate  ">0": refuse self signed and expired certificates

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