msg_internal.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_INTERNAL_H
#define MSG_INTERNAL_H
 
#ifdef MSG_H
#error "msg_internal.h" should be included before "msg.h"
#endif
 
#include "sofia-sip/msg.h"
#include "sofia-sip/msg_addr.h"
#include "sofia-sip/msg_buffer.h"
 
#ifndef SU_ALLOC_H
#include <sofia-sip/su_alloc.h>
#endif
 
SOFIA_BEGIN_DECLS
 
/* ---------------------------------------------------------------------- */
/* Types used when handling streaming */
 
typedef struct msg_buffer_s msg_buffer_t;
 
/* ---------------------------------------------------------------------- */
 
struct msg_s {
  su_home_t           m_home[1]; 
  msg_mclass_t const *m_class;  
  int                 m_oflags; 
  msg_pub_t          *m_object; 
  size_t              m_maxsize;
  size_t              m_size;   
  msg_header_t       *m_chain;  
  msg_header_t      **m_tail;   
  msg_payload_t      *m_chunk;  
  /* Parsing/printing buffer */
  struct msg_mbuffer_s {
    char     *mb_data;      
    usize_t   mb_size;      
    usize_t   mb_used;      
    usize_t   mb_commit;    
    unsigned  mb_eos:1;     
    unsigned :0;
  } m_buffer[1];
 
  msg_buffer_t  *m_stream;  
  size_t         m_ssize;   
  unsigned short m_extract_err; 
  /* Internal flags */
  unsigned       m_set_buffer:1;
  unsigned       m_streaming:1; 
  unsigned       m_prepared:1;  
  unsigned  :0;
 
  msg_t         *m_next;    
  msg_t         *m_parent;  
  int            m_refs;    
  su_addrinfo_t  m_addrinfo;    
  su_sockaddr_t  m_addr[1]; 
  int            m_errno;   
};
 
struct msg_buffer_s {
  char           *b_data;       
  size_t          b_size;       
  size_t          b_used;       
  size_t          b_avail;      
  int             b_complete;       
  msg_buffer_t   *b_next;       
  msg_payload_t  *b_chunks;     
};
 
 
struct hep_hdr{
    uint8_t hp_v;             /* version */
    uint8_t hp_l;             /* length */
    uint8_t hp_f;             /* family */
    uint8_t hp_p;             /* protocol */
    uint16_t hp_sport;        /* source port */
    uint16_t hp_dport;        /* destination port */
};
 
 
struct hep_iphdr{
        struct in_addr hp_src; 
        struct in_addr hp_dst;      /* source and dest address */
};
 
/* HEPv2 */
struct hep_timehdr{
    uint32_t tv_sec;         /* seconds */
    uint32_t tv_usec;        /* useconds */
    uint16_t captid;          /* Capture ID node */
};
 
#if SU_HAVE_IN6
struct hep_ip6hdr {
    struct in6_addr hp6_src;        /* source address */
    struct in6_addr hp6_dst;        /* destination address */
};
#endif
 
/* HEPv3 types */
 
#if (defined __SUNPRO_CC) || defined(__SUNPRO_C) || defined(_MSC_VER)
#define PACKED
#endif
#ifndef PACKED
#define PACKED __attribute__ ((__packed__))
#endif
 
#ifdef _MSC_VER
#pragma pack(push, 1)
#endif
 
struct hep_chunk {
       uint16_t vendor_id;
       uint16_t type_id;
       uint16_t length;
} PACKED;
 
typedef struct hep_chunk hep_chunk_t;
 
struct hep_chunk_uint8 {
       hep_chunk_t chunk;
       uint8_t data;
} PACKED;
 
typedef struct hep_chunk_uint8 hep_chunk_uint8_t;
 
struct hep_chunk_uint16 {
       hep_chunk_t chunk;
       uint16_t data;
} PACKED;
 
typedef struct hep_chunk_uint16 hep_chunk_uint16_t;
 
struct hep_chunk_uint32 {
       hep_chunk_t chunk;
       uint32_t data;
} PACKED;
 
typedef struct hep_chunk_uint32 hep_chunk_uint32_t;
 
struct hep_chunk_str {
       hep_chunk_t chunk;
       char *data;
} PACKED;
 
typedef struct hep_chunk_str hep_chunk_str_t;
 
struct hep_chunk_ip4 {
       hep_chunk_t chunk;
       struct in_addr data;
} PACKED;
 
typedef struct hep_chunk_ip4 hep_chunk_ip4_t;
 
struct hep_chunk_ip6 {
       hep_chunk_t chunk;
       struct in6_addr data;
} PACKED;
 
typedef struct hep_chunk_ip6 hep_chunk_ip6_t;
 
struct hep_chunk_payload {
    hep_chunk_t chunk;
    char *data;
} PACKED;
 
typedef struct hep_chunk_payload hep_chunk_payload_t;
 
struct hep_ctrl {
    char id[4];
    uint16_t length;
} PACKED;
 
typedef struct hep_ctrl hep_ctrl_t;
 
struct hep_generic {
        hep_ctrl_t         header;
        hep_chunk_uint8_t  ip_family;
        hep_chunk_uint8_t  ip_proto;
        hep_chunk_uint16_t src_port;
        hep_chunk_uint16_t dst_port;
        hep_chunk_uint32_t time_sec;
        hep_chunk_uint32_t time_usec;
        hep_chunk_uint8_t  proto_t;
        hep_chunk_uint32_t capt_id;
} PACKED;
 
#ifdef _MSC_VER
#pragma pack(pop)
#endif
 
typedef struct hep_generic hep_generic_t;
 
#define MSG_SSIZE_MAX (USIZE_MAX)
 
/* ---------------------------------------------------------------------- */
/* Header-kind predicate functions. */
su_inline int msg_is_single(msg_header_t const *h)
{
  return h->sh_class->hc_kind == msg_kind_single;
}
 
su_inline int msg_is_prepend(msg_header_t const *h)
{
  return h->sh_class->hc_kind == msg_kind_prepend;
}
 
su_inline int msg_is_append(msg_header_t const *h)
{
  return
    h->sh_class->hc_kind == msg_kind_append ||
    h->sh_class->hc_kind == msg_kind_non_compact_append ||
    h->sh_class->hc_kind == msg_kind_apndlist;
}
 
su_inline int msg_is_list(msg_header_t const *h)
{
  return h->sh_class->hc_kind == msg_kind_list;
}
 
su_inline int msg_is_special(msg_header_t const *h)
{
  return h->sh_class->hc_hash < 0;
}
 
SOFIA_END_DECLS
 
#endif /* MSG_INTERNAL_H */