eXosip.h

Go to the documentation of this file.

/*
  eXosip - This is the eXtended osip library.
  Copyright (C) 2001-2012 Aymeric MOIZARD amoizard@antisip.com
  
  eXosip is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
  
  eXosip is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/


#ifdef ENABLE_MPATROL
#include <mpatrol.h>
#endif

#ifndef __EXOSIP_H__
#define __EXOSIP_H__

#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>

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct eXosip_event eXosip_event_t;

  int eXosip_add_authentication_info (struct eXosip_t *excontext, const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm);

  int eXosip_remove_authentication_info (struct eXosip_t *excontext, const char *username, const char *realm);

  int eXosip_clear_authentication_info (struct eXosip_t *excontext);

  int eXosip_default_action (struct eXosip_t *excontext, eXosip_event_t * je);

  void eXosip_automatic_refresh (struct eXosip_t *excontext);

  void eXosip_automatic_action (struct eXosip_t *excontext);

#ifndef MINISIZE

  int eXosip_insubscription_automatic (struct eXosip_t *excontext, eXosip_event_t * evt);
#endif

  int eXosip_generate_random (char *buf, int buf_size);

  sdp_message_t *eXosip_get_remote_sdp (struct eXosip_t *excontext, int did);

  sdp_message_t *eXosip_get_local_sdp (struct eXosip_t *excontext, int did);

  sdp_message_t *eXosip_get_previous_local_sdp (struct eXosip_t *excontext, int did);

  sdp_message_t *eXosip_get_remote_sdp_from_tid (struct eXosip_t *excontext, int tid);

  sdp_message_t *eXosip_get_local_sdp_from_tid (struct eXosip_t *excontext, int tid);

  sdp_message_t *eXosip_get_sdp_info (osip_message_t * message);

  sdp_connection_t *eXosip_get_audio_connection (sdp_message_t * sdp);

  sdp_media_t *eXosip_get_audio_media (sdp_message_t * sdp);

  sdp_connection_t *eXosip_get_video_connection (sdp_message_t * sdp);

  sdp_media_t *eXosip_get_video_media (sdp_message_t * sdp);

  sdp_connection_t *eXosip_get_connection (sdp_message_t * sdp, const char *media);

  sdp_media_t *eXosip_get_media (sdp_message_t * sdp, const char *media);

  typedef enum eXosip_event_type {
    /* REGISTER related events */
    EXOSIP_REGISTRATION_SUCCESS,       
    EXOSIP_REGISTRATION_FAILURE,       
    /* INVITE related events within calls */
    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,         
    /* request related events within calls (except INVITE) */
    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,            
    /* for both UAS & UAC events */
    EXOSIP_CALL_RELEASED,             
    /* response received for request outside calls */
    EXOSIP_MESSAGE_NEW,              
    EXOSIP_MESSAGE_PROCEEDING,       
    EXOSIP_MESSAGE_ANSWERED,         
    EXOSIP_MESSAGE_REDIRECTED,       
    EXOSIP_MESSAGE_REQUESTFAILURE,   
    EXOSIP_MESSAGE_SERVERFAILURE,    
    EXOSIP_MESSAGE_GLOBALFAILURE,    
    /* Presence and Instant Messaging */
    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                  
  } eXosip_event_type_t;

  struct eXosip_event {
    eXosip_event_type_t type;               
    char textinfo[256];                     
    void *external_reference;               
    osip_message_t *request;       
    osip_message_t *response;      
    osip_message_t *ack;           
    int tid; 
    int did; 
    int rid; 
    int cid; 
    int sid; 
    int nid; 
    int ss_status;  
    int ss_reason;  
  };

  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);

#ifdef __cplusplus
}
#endif
#endif