sofia-sip/msg_types.h

Go to the documentation of this file.

/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef MSG_TYPES_H

#define MSG_TYPES_H

#ifndef SU_TYPES_H
#include <sofia-sip/su_types.h>
#endif

SOFIA_BEGIN_DECLS

typedef struct msg_mclass_s       msg_mclass_t;

typedef struct msg_hclass_s const msg_hclass_t;

typedef struct msg_href_s         msg_href_t;

typedef struct msg_s              msg_t;

#ifndef MSG_TIME_T_DEFINED
#define MSG_TIME_T_DEFINED

typedef unsigned long msg_time_t;
#endif

#ifndef MSG_TIME_MAX

#define MSG_TIME_MAX ((msg_time_t)ULONG_MAX)
#endif

#ifndef MSG_PUB_T
#ifdef MSG_OBJ_T
#define MSG_PUB_T MSG_OBJ_T
#else
#define MSG_PUB_T struct msg_pub_s
#endif
#endif

typedef MSG_PUB_T msg_pub_t;

#ifndef MSG_HDR_T
#define MSG_HDR_T union msg_header_u
#endif

typedef MSG_HDR_T msg_header_t;

typedef struct msg_common_s         msg_common_t;

typedef struct msg_separator_s      msg_separator_t;
typedef struct msg_payload_s        msg_payload_t;
typedef struct msg_unknown_s        msg_unknown_t;
typedef struct msg_error_s          msg_error_t;

typedef msg_common_t msg_frg_t;

typedef char const                 *msg_param_t;
typedef struct msg_numeric_s        msg_numeric_t;
typedef struct msg_generic_s        msg_generic_t;
typedef struct msg_list_s           msg_list_t;
typedef struct msg_auth_s           msg_auth_t;
typedef struct msg_auth_info_s      msg_auth_info_t;

#define MSG_HEADER_N 16377

struct msg_common_s {
  msg_header_t       *h_succ;   
  msg_header_t      **h_prev;   
  msg_hclass_t       *h_class;  
  void const         *h_data;   
  usize_t             h_len;    
};


struct msg_pub_s {
  msg_common_t        msg_common[1]; 
  msg_pub_t          *msg_next;
  void               *msg_user;
  unsigned            msg_size;
  unsigned            msg_flags;
  msg_error_t        *msg_error;
  msg_header_t       *msg_request;
  msg_header_t       *msg_status;
  msg_header_t       *msg_headers[MSG_HEADER_N];
};

#define msg_ident msg_common->h_class

struct msg_numeric_s {
  msg_common_t   x_common[1];       
  msg_numeric_t *x_next;            
  unsigned long  x_value;           
};

struct msg_generic_s {
  msg_common_t   g_common[1];       
  msg_generic_t *g_next;            
  char const    *g_string;          
};

struct msg_list_s {
  msg_common_t       k_common[1];   
  msg_list_t        *k_next;        
  msg_param_t       *k_items;       
};

struct msg_auth_s {
  msg_common_t       au_common[1];  
  msg_auth_t        *au_next;       
  char const        *au_scheme;     
  msg_param_t const *au_params;     
};

struct msg_auth_info_s
{
  msg_common_t        ai_common[1]; 
  msg_error_t        *ai_next;      
  msg_param_t const  *ai_params;    
};

struct msg_unknown_s {
  msg_common_t    un_common[1];  
  msg_unknown_t  *un_next;       
  char const     *un_name;       
  char const     *un_value;      
};

struct msg_error_s {
  msg_common_t    er_common[1];  
  msg_error_t    *er_next;       
  char const     *er_name;       
};


struct msg_separator_s {
  msg_common_t    sep_common[1]; 
  msg_error_t    *sep_next;      
  char            sep_data[4];   
};

struct msg_payload_s {
  msg_common_t    pl_common[1];     
  msg_payload_t  *pl_next;          
  char           *pl_data;          
  usize_t         pl_len;           
};

union msg_header_u {
  msg_common_t    sh_common[1];     
  struct {
    msg_common_t  shn_common;
    msg_header_t *shn_next;
  }               sh_header_next[1];
#define sh_next   sh_header_next->shn_next
#define sh_class  sh_common->h_class
#define sh_succ   sh_common->h_succ
#define sh_prev   sh_common->h_prev
#define sh_data   sh_common->h_data
#define sh_len    sh_common->h_len

  msg_generic_t   sh_generic[1];
  msg_numeric_t   sh_numeric[1];
  msg_list_t      sh_list[1];
  msg_auth_t      sh_auth[1];
  msg_separator_t sh_separator[1];
  msg_payload_t   sh_payload[1];
  msg_unknown_t   sh_unknown[1];
  msg_error_t     sh_error[1];
};

/* ====================================================================== */

typedef enum {
  msg_kind_single,              
  msg_kind_append,              
  msg_kind_list,                
  msg_kind_apndlist,            
  msg_kind_prepend              
} msg_header_kind_t;

struct su_home_s;

typedef issize_t msg_parse_f(struct su_home_s *, msg_header_t *, char *, isize_t);
typedef issize_t msg_print_f(char buf[], isize_t bufsiz,
                             msg_header_t const *, int flags);
typedef char *msg_dup_f(msg_header_t *dst, msg_header_t const *src,
                        char *buf, isize_t bufsiz);
typedef isize_t msg_xtra_f(msg_header_t const *h, isize_t offset);

typedef int msg_update_f(msg_common_t *, char const *name, isize_t namelen,
                         char const *value);

struct msg_hclass_s
{
  /* XXX size of header class missing. Someone has saved bits in wrong place. */
  int               hc_hash;    
  msg_parse_f      *hc_parse;   
  msg_print_f      *hc_print;   
  msg_xtra_f       *hc_dxtra;   
  msg_dup_f        *hc_dup_one; 
  msg_update_f     *hc_update;  
  char const       *hc_name;    
  short             hc_len;     
  char              hc_short[2];
  unsigned char     hc_size;    
  unsigned char     hc_params;  
  unsigned          hc_kind:3;  
  unsigned          hc_critical:1; 
  unsigned          /*pad*/:0;
};

#define HC_LEN_MAX SHRT_MAX

SOFIA_END_DECLS

#endif /* !defined MSG_TYPES_H */