osip_message.h

Go to the documentation of this file.

/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001-2020 Aymeric MOIZARD amoizard@antisip.com
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library 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
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
 
#ifndef _OSIP_MESSAGE_H_
#define _OSIP_MESSAGE_H_
 
#include <osipparser2/osip_const.h>
#include <osipparser2/osip_headers.h>
#include <osipparser2/osip_body.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct osip_message osip_message_t;
 
struct osip_message {
  char *sip_version;   
  osip_uri_t *req_uri; 
  char *sip_method;    
  int status_code;     
  char *reason_phrase; 
#ifndef MINISIZE
  osip_list_t accepts;              
  osip_list_t accept_encodings;     
  osip_list_t accept_languages;     
  osip_list_t alert_infos;          
  osip_list_t allows;               
  osip_list_t authentication_infos; 
#endif
  osip_list_t authorizations; 
  osip_call_id_t *call_id;    
  osip_list_t call_infos;     
  osip_list_t contacts;       
#ifndef MINISIZE
  osip_list_t content_encodings; 
#endif
  osip_content_length_t *content_length; 
  osip_content_type_t *content_type;     
  osip_cseq_t *cseq;                     
#ifndef MINISIZE
  osip_list_t error_infos; 
#endif
  osip_from_t *from;                 
  osip_mime_version_t *mime_version; 
  osip_list_t proxy_authenticates;   
#ifndef MINISIZE
  osip_list_t proxy_authentication_infos; 
#endif
  osip_list_t proxy_authorizations; 
  osip_list_t record_routes;        
  osip_list_t routes;               
  osip_to_t *to;                    
  osip_list_t vias;                 
  osip_list_t www_authenticates;    
  osip_list_t headers; 
  osip_list_t bodies; 
  /*
     1: structure and buffer "message" are identical.
     2: buffer "message" is not up to date with the structure info (call osip_message_to_str to update it).
   */
  int message_property;  
  char *message;         
  size_t message_length; 
  void *application_data; 
};
 
#ifndef SIP_MESSAGE_MAX_LENGTH
#define SIP_MESSAGE_MAX_LENGTH 8000
#endif
 
#ifndef BODY_MESSAGE_MAX_SIZE
#define BODY_MESSAGE_MAX_SIZE 4000
#endif
 
int osip_message_init(osip_message_t **sip);
void osip_message_free(osip_message_t *sip);
int osip_message_parse(osip_message_t *sip, const char *buf, size_t length);
int osip_message_parse_sipfrag(osip_message_t *sip, const char *buf, size_t length);
int osip_message_to_str(osip_message_t *sip, char **dest, size_t *message_length);
int osip_message_to_str_sipfrag(osip_message_t *sip, char **dest, size_t *message_length);
int osip_message_clone(const osip_message_t *sip, osip_message_t **dest);
 
void osip_message_set_reason_phrase(osip_message_t *sip, char *reason);
char *osip_message_get_reason_phrase(const osip_message_t *sip);
void osip_message_set_status_code(osip_message_t *sip, int statuscode);
int osip_message_get_status_code(const osip_message_t *sip);
void osip_message_set_method(osip_message_t *sip, char *method);
char *osip_message_get_method(const osip_message_t *sip);
void osip_message_set_version(osip_message_t *sip, char *version);
char *osip_message_get_version(const osip_message_t *sip);
void osip_message_set_uri(osip_message_t *sip, osip_uri_t *uri);
osip_uri_t *osip_message_get_uri(const osip_message_t *sip);
 
/*
 *  These are helpfull MACROs to test messages type.
 */
#define MSG_IS_RESPONSE(msg) ((msg)->status_code != 0)
#define MSG_IS_REQUEST(msg) ((msg)->status_code == 0)
 
#define MSG_IS_INVITE(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "INVITE"))
#define MSG_IS_ACK(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "ACK"))
#define MSG_IS_REGISTER(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "REGISTER"))
#define MSG_IS_BYE(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "BYE"))
#define MSG_IS_OPTIONS(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "OPTIONS"))
#define MSG_IS_INFO(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "INFO"))
#define MSG_IS_CANCEL(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "CANCEL"))
#define MSG_IS_REFER(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "REFER"))
#define MSG_IS_NOTIFY(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "NOTIFY"))
#define MSG_IS_SUBSCRIBE(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "SUBSCRIBE"))
#define MSG_IS_MESSAGE(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "MESSAGE"))
#define MSG_IS_PRACK(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "PRACK"))
 
#define MSG_IS_UPDATE(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "UPDATE"))
 
#define MSG_IS_PUBLISH(msg) (MSG_IS_REQUEST(msg) && 0 == strcmp((msg)->sip_method, "PUBLISH"))
 
#define MSG_IS_STATUS_1XX(msg) ((msg)->status_code >= 100 && (msg)->status_code < 200)
#define MSG_IS_STATUS_2XX(msg) ((msg)->status_code >= 200 && (msg)->status_code < 300)
#define MSG_IS_STATUS_3XX(msg) ((msg)->status_code >= 300 && (msg)->status_code < 400)
#define MSG_IS_STATUS_4XX(msg) ((msg)->status_code >= 400 && (msg)->status_code < 500)
#define MSG_IS_STATUS_5XX(msg) ((msg)->status_code >= 500 && (msg)->status_code < 600)
#define MSG_IS_STATUS_6XX(msg) ((msg)->status_code >= 600 && (msg)->status_code < 700)
#define MSG_TEST_CODE(msg, code) (MSG_IS_RESPONSE(msg) && (code) == (msg)->status_code)
#define MSG_IS_RESPONSE_FOR(msg, requestname) (MSG_IS_RESPONSE(msg) && 0 == strcmp((msg)->cseq->method, (requestname)))
 
#define osip_generic_param_init(GP) osip_uri_param_init(GP)
#define osip_generic_param_free(GP) osip_uri_param_free(GP)
#define osip_generic_param_set(GP, NAME, VALUE) osip_uri_param_set(GP, NAME, VALUE)
#define osip_generic_param_clone osip_uri_param_clone
#ifndef DOXYGEN
/*
 * Free a list of a generic parameter element.
 * @param LIST The list of generic parameter element to free.
 */
#define osip_generic_param_freelist(LIST) osip_uri_param_freelist(LIST)
#endif
#define osip_generic_param_add(LIST, NAME, VALUE) osip_uri_param_add(LIST, NAME, VALUE)
#define osip_generic_param_get_byname(LIST, NAME, DEST) osip_uri_param_get_byname(LIST, NAME, DEST)
 
void osip_generic_param_set_name(osip_generic_param_t *generic_param, char *name);
char *osip_generic_param_get_name(const osip_generic_param_t *generic_param);
void osip_generic_param_set_value(osip_generic_param_t *generic_param, char *value);
char *osip_generic_param_get_value(const osip_generic_param_t *generic_param);
 
int osip_message_get_knownheaderlist(osip_list_t *header_list, int pos, void **dest);
 
#ifdef __cplusplus
}
#endif
#endif