DOKK / manpages / debian 10 / libexosip2-dev / eXosip2_event.3.en
eXosip2_event(3) libeXosip2 eXosip2_event(3)

eXosip2_event - eXosip2 event API


struct eXosip_event


enum eXosip_event_type { EXOSIP_REGISTRATION_SUCCESS, EXOSIP_REGISTRATION_FAILURE, EXOSIP_CALL_INVITE, EXOSIP_CALL_REINVITE, EXOSIP_CALL_NOANSWER, EXOSIP_CALL_PROCEEDING, EXOSIP_CALL_RINGING, EXOSIP_CALL_ANSWERED, EXOSIP_CALL_REDIRECTED, EXOSIP_CALL_REQUESTFAILURE, EXOSIP_CALL_SERVERFAILURE, EXOSIP_CALL_GLOBALFAILURE, EXOSIP_CALL_ACK, EXOSIP_CALL_CANCELLED, EXOSIP_CALL_MESSAGE_NEW, EXOSIP_CALL_MESSAGE_PROCEEDING, EXOSIP_CALL_MESSAGE_ANSWERED, EXOSIP_CALL_MESSAGE_REDIRECTED, EXOSIP_CALL_MESSAGE_REQUESTFAILURE, EXOSIP_CALL_MESSAGE_SERVERFAILURE, EXOSIP_CALL_MESSAGE_GLOBALFAILURE, EXOSIP_CALL_CLOSED, EXOSIP_CALL_RELEASED, EXOSIP_MESSAGE_NEW, EXOSIP_MESSAGE_PROCEEDING, EXOSIP_MESSAGE_ANSWERED, EXOSIP_MESSAGE_REDIRECTED, EXOSIP_MESSAGE_REQUESTFAILURE, EXOSIP_MESSAGE_SERVERFAILURE, EXOSIP_MESSAGE_GLOBALFAILURE, EXOSIP_SUBSCRIPTION_NOANSWER, EXOSIP_SUBSCRIPTION_PROCEEDING, EXOSIP_SUBSCRIPTION_ANSWERED, EXOSIP_SUBSCRIPTION_REDIRECTED, EXOSIP_SUBSCRIPTION_REQUESTFAILURE, EXOSIP_SUBSCRIPTION_SERVERFAILURE, EXOSIP_SUBSCRIPTION_GLOBALFAILURE, EXOSIP_SUBSCRIPTION_NOTIFY, EXOSIP_IN_SUBSCRIPTION_NEW, EXOSIP_NOTIFICATION_NOANSWER, EXOSIP_NOTIFICATION_PROCEEDING, EXOSIP_NOTIFICATION_ANSWERED, EXOSIP_NOTIFICATION_REDIRECTED, EXOSIP_NOTIFICATION_REQUESTFAILURE, EXOSIP_NOTIFICATION_SERVERFAILURE, EXOSIP_NOTIFICATION_GLOBALFAILURE, EXOSIP_EVENT_COUNT }


void eXosip_event_free (eXosip_event_t *je)
eXosip_event_t * eXosip_event_wait (struct eXosip_t *excontext, int tv_s, int tv_ms)
eXosip_event_t * eXosip_event_get (struct eXosip_t *excontext)
int eXosip_event_geteventsocket (struct eXosip_t *excontext)

Structure for event type description

Enumerator

user is successfully registred.
user is not registred.
announce a new call
announce a new INVITE within call
announce no answer within the timeout
announce processing by a remote app
announce ringback
announce start of call
announce a redirection
announce a request failure
announce a server failure
announce a global failure
ACK received for 200ok to INVITE
announce that call has been cancelled
announce new incoming request.
announce a 1xx for request.
announce a 200ok
announce a failure.
announce a failure.
announce a failure.
announce a failure.
a BYE was received for this call
call context is cleared.
announce new incoming request.
announce a 1xx for request.
announce a 200ok
announce a failure.
announce a failure.
announce a failure.
announce a failure.
announce no answer
announce a 1xx
announce a 200ok
announce a redirection
announce a request failure
announce a server failure
announce a global failure
announce new NOTIFY request
announce new incoming SUBSCRIBE.
announce no answer
announce a 1xx
announce a 200ok
announce a redirection
announce a request failure
announce a server failure
announce a global failure
MAX number of events

Free resource in an eXosip event.

Parameters:

je event to work on.

eXosip_event_t* eXosip_event_wait (struct eXosip_t * excontext, int tv_s, int tv_ms)

Wait for an eXosip event.

Parameters:

excontext eXosip_t instance.
tv_s timeout value (seconds).
tv_ms timeout value (mseconds).

eXosip_event_t* eXosip_event_get (struct eXosip_t * excontext)

Wait for next eXosip event. DEPRECATED API 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.

Parameters:

excontext eXosip_t instance.

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.

Parameters:

excontext eXosip_t instance.

Generated automatically by Doxygen for libeXosip2 from the source code.

Thu Dec 15 2016 Version 4.1.0