eXosip.h File Reference

eXosip API More...

#include <eXosip2/eX_setup.h>
#include <eXosip2/eX_register.h>
#include <eXosip2/eX_call.h>
#include <eXosip2/eX_options.h>
#include <eXosip2/eX_subscribe.h>
#include <eXosip2/eX_refer.h>
#include <eXosip2/eX_message.h>
#include <eXosip2/eX_publish.h>
#include <osipparser2/osip_parser.h>
#include <osipparser2/sdp_message.h>
#include <time.h>

Include dependency graph for eXosip.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	eXosip_event
	Structure for event description. More...

Macros
#define	__EXOSIP_H__

Typedefs
typedef struct eXosip_event	eXosip_event_t
	Structure for event description. More...
typedef enum eXosip_event_type	eXosip_event_type_t

Enumerations
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 }
	Structure for event type description. More...

Functions
int	eXosip_add_authentication_info (struct eXosip_t *excontext, const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm)
	Add authentication credentials. More...
int	eXosip_remove_authentication_info (struct eXosip_t *excontext, const char *username, const char *realm)
	Remove authentication credentials. More...
int	eXosip_clear_authentication_info (struct eXosip_t *excontext)
	Clear all authentication credentials stored in eXosip. More...
int	eXosip_default_action (struct eXosip_t *excontext, eXosip_event_t *je)
	Initiate some default actions: More...
void	eXosip_automatic_refresh (struct eXosip_t *excontext)
	Initiate some automatic actions: More...
void	eXosip_automatic_action (struct eXosip_t *excontext)
	Initiate some automatic actions: More...
int	eXosip_insubscription_automatic (struct eXosip_t *excontext, eXosip_event_t *evt)
	Automatic internal handling of dialog package. More...
int	eXosip_generate_random (char *buf, int buf_size)
	Generate random string: More...
sdp_message_t *	eXosip_get_remote_sdp (struct eXosip_t *excontext, int did)
	Get remote SDP body for the latest INVITE of call. More...
sdp_message_t *	eXosip_get_local_sdp (struct eXosip_t *excontext, int did)
	Get local SDP body for the latest INVITE of call. More...
sdp_message_t *	eXosip_get_previous_local_sdp (struct eXosip_t *excontext, int did)
	Get local SDP body for the previous latest INVITE of call. More...
sdp_message_t *	eXosip_get_remote_sdp_from_tid (struct eXosip_t *excontext, int tid)
	Get remote SDP body for the latest INVITE of call. More...
sdp_message_t *	eXosip_get_local_sdp_from_tid (struct eXosip_t *excontext, int tid)
	Get local SDP body for the latest INVITE of call. More...
sdp_message_t *	eXosip_get_sdp_info (osip_message_t *message)
	Get local SDP body for the given message. More...
sdp_connection_t *	eXosip_get_audio_connection (sdp_message_t *sdp)
	Get audio connection information for call. More...
sdp_media_t *	eXosip_get_audio_media (sdp_message_t *sdp)
	Get audio media information for call. More...
sdp_connection_t *	eXosip_get_video_connection (sdp_message_t *sdp)
	Get video connection information for call. More...
sdp_media_t *	eXosip_get_video_media (sdp_message_t *sdp)
	Get video media information for call. More...
sdp_connection_t *	eXosip_get_connection (sdp_message_t *sdp, const char *media)
	Get media connection information for call. More...
sdp_media_t *	eXosip_get_media (sdp_message_t *sdp, const char *media)
	Get media information for call. More...
void	eXosip_event_free (eXosip_event_t *je)
	Free ressource in an eXosip event. More...
eXosip_event_t *	eXosip_event_wait (struct eXosip_t *excontext, int tv_s, int tv_ms)
	Wait for an eXosip event. More...
eXosip_event_t *	eXosip_event_get (struct eXosip_t *excontext)
	Wait for next eXosip event. More...
int	eXosip_event_geteventsocket (struct eXosip_t *excontext)
	This socket receive some data yhen an event happens internally. More...

Detailed Description

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:

• SIP User-Agents
• SIP Voicemail or IVR
• SIP B2BUA
• any SIP server acting as an endpoint (music server...)

If you need to implement proxy or complex SIP applications, you should consider using osip instead.

Here are the eXosip capabilities:

   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!

Definition in file eXosip.h.

Macro Definition Documentation

#define __EXOSIP_H__

Definition at line 26 of file eXosip.h.

Typedef Documentation

eXosip_event_t

Structure for event description.

Definition at line 81 of file eXosip.h.