.TH "eXosip.h" 3 "Thu Dec 15 2016" "Version 4.1.0" "libeXosip2" \" -*- nroff -*- .ad l .nh .SH NAME eXosip.h \- eXosip API .SH SYNOPSIS .br .PP \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br \fC#include \fP .br .SS "Data Structures" .in +1c .ti -1c .RI "struct \fBeXosip_event\fP" .br .in -1c .SS "Typedefs" .in +1c .ti -1c .RI "typedef struct \fBeXosip_event\fP \fBeXosip_event_t\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 "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 .ti -1c .RI "sdp_message_t * \fBeXosip_get_remote_sdp\fP (struct eXosip_t *excontext, int did)" .br .ti -1c .RI "sdp_message_t * \fBeXosip_get_local_sdp\fP (struct eXosip_t *excontext, int did)" .br .ti -1c .RI "sdp_message_t * \fBeXosip_get_previous_local_sdp\fP (struct eXosip_t *excontext, int did)" .br .ti -1c .RI "sdp_message_t * \fBeXosip_get_remote_sdp_from_tid\fP (struct eXosip_t *excontext, int tid)" .br .ti -1c .RI "sdp_message_t * \fBeXosip_get_local_sdp_from_tid\fP (struct eXosip_t *excontext, int tid)" .br .ti -1c .RI "sdp_message_t * \fBeXosip_get_sdp_info\fP (osip_message_t *message)" .br .ti -1c .RI "sdp_connection_t * \fBeXosip_get_audio_connection\fP (sdp_message_t *sdp)" .br .ti -1c .RI "sdp_media_t * \fBeXosip_get_audio_media\fP (sdp_message_t *sdp)" .br .ti -1c .RI "sdp_connection_t * \fBeXosip_get_video_connection\fP (sdp_message_t *sdp)" .br .ti -1c .RI "sdp_media_t * \fBeXosip_get_video_media\fP (sdp_message_t *sdp)" .br .ti -1c .RI "sdp_connection_t * \fBeXosip_get_connection\fP (sdp_message_t *sdp, const char *media)" .br .ti -1c .RI "sdp_media_t * \fBeXosip_get_media\fP (sdp_message_t *sdp, const char *media)" .br .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 eXosip API eXosip is a high layer library for rfc3261: the SIP protocol\&. It offers a simple API to make it easy to use\&. eXosip2 offers great flexibility for implementing SIP endpoint like: .PD 0 .IP "\(bu" 2 SIP User-Agents .IP "\(bu" 2 SIP Voicemail or IVR .IP "\(bu" 2 SIP B2BUA .IP "\(bu" 2 any SIP server acting as an endpoint (music server\&.\&.\&.) .PP .PP If you need to implement proxy or complex SIP applications, you should consider using osip instead\&. .PP Here are the eXosip capabilities: .PP .nf REGISTER to handle registration\&. INVITE/BYE to start/stop VoIP sessions\&. INFO to send DTMF within a VoIP sessions\&. OPTIONS to simulate VoIP sessions\&. re-INVITE to modify VoIP sessions REFER/NOTIFY to transfer calls\&. MESSAGE to send Instant Message\&. SUBSCRIBE/NOTIFY to handle presence capabilities\&. any other request to handle what you want! .fi .PP .SH "Typedef Documentation" .PP .SS "\fBeXosip_event_t\fP" Structure for event description\&. .SH "Author" .PP Generated automatically by Doxygen for libeXosip2 from the source code\&.