eXosip2_event man page
eXosip2_event struct eXosip_event enum eXosip_event_type { EXOSIP_REGISTRATION_NEW, EXOSIP_REGISTRATION_SUCCESS, EXOSIP_REGISTRATION_FAILURE, EXOSIP_REGISTRATION_REFRESHED, EXOSIP_REGISTRATION_TERMINATED, 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_TIMEOUT, 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_UPDATE, EXOSIP_SUBSCRIPTION_CLOSED, 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_SUBSCRIPTION_RELEASED, EXOSIP_IN_SUBSCRIPTION_NEW, EXOSIP_IN_SUBSCRIPTION_RELEASED, 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) Structure for event type description Enumerator announce new registration. user is successfully registred. user is not registred. registration has been refreshed. UA is not registred any more. 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 that call has failed 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 incoming SUBSCRIBE. announce end of subscription. 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 call context is cleared. announce new incoming SUBSCRIBE. announce end of subscription. 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 An enumeration which describes the error which can occur while setting the eXosip_tls_ctx Enumerator yippieh, everything is fine :) no absolute path to the random file was specified no absolute path to the diifie hellman file was specified no password was specified no absolute path to the rootCA file was specified something is missing: the private key or the certificate Free ressource in an eXosip event. je event to work on. Wait for an eXosip event. tv_s timeout value (seconds). Wait for next eXosip event. 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. sets the parameters for the TLS context, which is used for encrypted connections ctx,IN a struct which holds the necessary parameters the eXosip_tls_ctx_error code Select by CN name the server certificate from OS store. 12/11/2009 -> implemented only for 'Windows Certificate Store' local_certificate_cn CN name of the certificate to send on incoming connection the eXosip_tls_ctx_error code Select by CN name the client certificate from OS store. 31/1/2011 -> implemented only for 'Windows Certificate Store' local_certificate_cn CN name of the certificate to send on outgoing connection the eXosip_tls_ctx_error code NOTE: default is to accept (0) Generated automatically by Doxygen for libeXosip2 from the source code.Synopsis
Data Structures
struct eXosip_tls_credentials_s
struct eXosip_tls_ctx_sEnumerations
enum eXosip_tls_ctx_error { TLS_OK = 0, TLS_ERR_NO_RAND = -1, TLS_ERR_NO_DH_PARAM = -2, TLS_ERR_NO_PW = -3, TLS_ERR_NO_ROOT_CA = -4, TLS_ERR_MISSING_AUTH_PART = -5 }Functions
eXosip_event_t * eXosip_event_wait (int tv_s, int tv_ms)
eXosip_event_t * eXosip_event_get (void)
int eXosip_event_geteventsocket (void)
eXosip_tls_ctx_error eXosip_set_tls_ctx (eXosip_tls_ctx_t *ctx)
eXosip_tls_ctx_error eXosip_tls_use_server_certificate (const char *local_certificate_cn)
eXosip_tls_ctx_error eXosip_tls_use_client_certificate (const char *local_certificate_cn)
eXosip_tls_ctx_error eXosip_tls_verify_certificate (int _tls_verify_client_certificate)Detailed Description
Enumeration Type Documentation
enum eXosip_event_type
enum eXosip_tls_ctx_error
Function Documentation
void eXosip_event_free (eXosip_event_t * je)
eXosip_event_t* eXosip_event_wait (int tv_s, int tv_ms)
tv_ms timeout value (mseconds). eXosip_event_t* eXosip_event_get (void)
int eXosip_event_geteventsocket (void)
eXosip_tls_ctx_error eXosip_set_tls_ctx (eXosip_tls_ctx_t * ctx)
eXosip_tls_ctx_error eXosip_tls_use_server_certificate (const char * local_certificate_cn)
eXosip_tls_ctx_error eXosip_tls_use_client_certificate (const char * local_certificate_cn)
eXosip_tls_ctx_error eXosip_tls_verify_certificate (int _tls_verify_client_certificate)
Configure to accept/reject self signed and expired certificates.
@param _tls_verify_client_certificate ">0": refuse self signed and expired certificates
@return the eXosip_tls_ctx_error code
Author
Info