.TH "eXosip2_event" 3 "Thu Dec 15 2016" "Version 4.1.0" "libeXosip2" \" -*- nroff -*- .ad l .nh .SH NAME eXosip2_event \- eXosip2 event API .SS "Data Structures" .in +1c .ti -1c .RI "struct \fBeXosip_event\fP" .br .in -1c .SS "Enumerations" .in +1c .ti -1c .RI "enum \fBeXosip_event_type\fP { \fBEXOSIP_REGISTRATION_SUCCESS\fP, \fBEXOSIP_REGISTRATION_FAILURE\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_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_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_IN_SUBSCRIPTION_NEW\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 .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 (struct eXosip_t *excontext, int tv_s, int tv_ms)" .br .ti -1c .RI "\fBeXosip_event_t\fP * \fBeXosip_event_get\fP (struct eXosip_t *excontext)" .br .ti -1c .RI "int \fBeXosip_event_geteventsocket\fP (struct eXosip_t *excontext)" .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_SUCCESS \fP\fP user is successfully registred\&. .TP \fB\fIEXOSIP_REGISTRATION_FAILURE \fP\fP user is not registred\&. .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_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_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_IN_SUBSCRIPTION_NEW \fP\fP announce new incoming SUBSCRIBE\&. .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 .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 (struct eXosip_t * excontext, int tv_s, int tv_ms)" Wait for an eXosip event\&. .PP \fBParameters:\fP .RS 4 \fIexcontext\fP eXosip_t instance\&. .br \fItv_s\fP timeout value (seconds)\&. .br \fItv_ms\fP timeout value (mseconds)\&. .RE .PP .SS "\fBeXosip_event_t\fP* eXosip_event_get (struct eXosip_t * excontext)" Wait for next eXosip event\&. \fBDEPRECATED API\fP This API will block - You should use eXosip_event_wait instead which is more convenient\&. limitation: This method will not process automatic 200ok retransmission for INVITE transaction\&. .PP \fBParameters:\fP .RS 4 \fIexcontext\fP eXosip_t instance\&. .RE .PP .SS "int eXosip_event_geteventsocket (struct eXosip_t * excontext)" 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\&. .PP \fBParameters:\fP .RS 4 \fIexcontext\fP eXosip_t instance\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for libeXosip2 from the source code\&.