Parser :: ??? More...

#include "../comp_defs.h"
#include "../str.h"
#include "../lump_struct.h"
#include "../flags.h"
#include "../ip_addr.h"
#include "../md5utils.h"
#include "../config.h"
#include "parse_def.h"
#include "parse_cseq.h"
#include "parse_via.h"
#include "parse_fline.h"
#include "parse_retry_after.h"
#include "hf.h"
#include "../error.h"
#include "../lump_struct.h"
#include "../flags.h"
#include "../ip_addr.h"
#include "../md5utils.h"
#include "../error.h"

Include dependency graph for msg_parser.h:

Go to the source code of this file.

Data Structures

struct msg_body
This structure represents a generic SIP message body, regardless of the body type. More...
struct msg_ctx_id
struct to identify a msg context
- the pair of pid and message-id
More...
struct sip_msg
The SIP message. More...
struct sip_uri
The SIP uri object. More...

Defines

#define FAKED_REPLY ((struct sip_msg *) -1)
pointer to a fakes message which was never received ; (when this message is "relayed", it is generated out of the original request)
#define FL_ADD_LOCAL_RPORT (1 << 11)
add 'rport' to local via hdr
#define FL_FORCE_ACTIVE (1 << 1)
force active SDP
#define FL_FORCE_RPORT (1 << 0)
force rport
#define FL_HASH_INDEX (1 << 7)
msg->hash_index contains a valid value (tm use)
#define FL_REPLIED (1 << 6)
message branch received at least one reply (for failure route use)
#define FL_SDP_BODY (1 << 12)
msg has SDP in body
#define FL_SDP_IP_AFS (1 << 2)
SDP IP rewritten.
#define FL_SDP_PORT_AFS (1 << 3)
SDP port rewritten.
#define FL_SHM_CLONE (1 << 4)
msg cloned in SHM as a single chunk
#define FL_TIMEOUT (1 << 5)
message belongs to an "expired" branch (for failure route use)
#define GET_NEXT_HOP(m)
Return a URI to which the message should be really sent (not what should be in the Request URI.
#define GET_RURI(m) (((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri))
Return the Reqeust URI of a message.
#define reset_force_socket(msg) set_force_socket(msg, 0)
reset a previously forced send socket.
#define set_force_socket(msg, fsocket)
force a specific send socket for forwarding a request.
#define SIP_MSG_START(m) ((m)->first_line.u.request.method.s)
start of "actual" sip msg (start of first line)

convenience short-cut macros

#define REQ_LINE(_msg) ((_msg)->first_line.u.request)
#define REQ_METHOD first_line.u.request.method_value
#define REPLY_STATUS first_line.u.reply.statuscode
#define REPLY_CLASS(_reply) ((_reply)->REPLY_STATUS/100)

Typedefs

typedef struct msg_body msg_body_t
This structure represents a generic SIP message body, regardless of the body type.
typedef struct msg_ctx_id msg_ctx_id_t
struct to identify a msg context
- the pair of pid and message-id
typedef struct sip_msg sip_msg_t
The SIP message.

Enumerations

enum request_method {
  METHOD_UNDEF = 0, METHOD_INVITE = 1, METHOD_CANCEL = 2, METHOD_ACK = 4,
  METHOD_BYE = 8, METHOD_INFO = 16, METHOD_REGISTER = 32, METHOD_SUBSCRIBE = 64,
  METHOD_NOTIFY = 128, METHOD_MESSAGE = 256, METHOD_OPTIONS = 512, METHOD_PRACK = 1024,
  METHOD_UPDATE = 2048, METHOD_REFER = 4096, METHOD_PUBLISH = 8192, METHOD_OTHER = 16384
}
number methods as power of two to allow bitmap matching
More...

Functions

static int check_transaction_quadruple (struct sip_msg *msg)
make sure all HFs needed for transaction identification have been parsed; return 0 if those HFs can't be found
static char * get_body (struct sip_msg *msg)
returns a pointer to the begining of the msg's body
int msg_ctx_id_match (sip_msg_t *msg, msg_ctx_id_t *mid)
check msg context id
- return: -1 on error; 0 - on no match; 1 - on match
int msg_ctx_id_set (sip_msg_t *msg, msg_ctx_id_t *mid)
set msg context id
- return: -1 on error; 0 - on set
int msg_set_time (sip_msg_t *msg)
set msg time value
void reset_dst_uri (struct sip_msg *msg)
If the dst_uri is set to an URI then reset it.
int set_dst_uri (struct sip_msg *msg, str *uri)
Make a private copy of the string and assign it to dst_uri.

Variables

unsigned int global_req_flags
global request flags.

Detailed Description

Definition in file msg_parser.h.

Define Documentation

#define GET_NEXT_HOP ( m )

Value:

(((m)->dst_uri.s && (m)->dst_uri.len) ? (&(m)->dst_uri) : \
(((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri)))

The following fields are tried in this order: 1) dst_uri 2) new_uri 3) first_line.u.request.uri

Definition at line 167 of file msg_parser.h.

#define GET_RURI ( m ) (((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri))

The following fields are tried in this order: 1) new_uri 2) first_line.u.request.uri

Definition at line 178 of file msg_parser.h.

#define reset_force_socket ( msg ) set_force_socket(msg, 0)

Definition at line 467 of file msg_parser.h.

#define set_force_socket	(	msg,
		fsocket
	)

Value:

do { \
                (msg)->force_send_socket=(fsocket); \
                if ((msg)->force_send_socket) \
                        (msg)->fwd_send_flags.f |= SND_F_FORCE_SOCKET; \
                else \
                        (msg)->fwd_send_flags.f &= ~SND_F_FORCE_SOCKET; \
        } while (0)

Parameters:

	msg	- sip msg.
	fsocket	- forced socket, pointer to struct socket_info, can be 0 (in which case it's equivalent to reset_force_socket()).

Definition at line 457 of file msg_parser.h.

Referenced by after_loose(), after_strict(), dp_apply_policy(), and lookup().

Typedef Documentation

typedef struct msg_body msg_body_t

Body parsers are supposed to cast this structure to some other body-type specific structure, but the body type specific structure must retain msg_body_type variable and a pointer to the free function as the first two variables within the structure.

Enumeration Type Documentation

enum request_method

Enumerator:

METHOD_UNDEF	0 - ---
METHOD_INVITE	1 - 2^0
METHOD_CANCEL	2 - 2^1
METHOD_ACK	4 - 2^2
METHOD_BYE	8 - 2^3
METHOD_INFO	16 - 2^4
METHOD_REGISTER	32 - 2^5
METHOD_SUBSCRIBE	64 - 2^6
METHOD_NOTIFY	128 - 2^7
METHOD_MESSAGE	256 - 2^8
METHOD_OPTIONS	512 - 2^9
METHOD_PRACK	1024 - 2^10
METHOD_UPDATE	2048 - 2^11
METHOD_REFER	4096 - 2^12
METHOD_PUBLISH	8192 - 2^13
METHOD_OTHER	16384 - 2^14

Definition at line 87 of file msg_parser.h.

Variable Documentation

unsigned int global_req_flags

msg->msg_flags should be OR'ed with it before a flag value is checked, e.g.: if ((msg->msg_flags|global_req_flags) & FL_XXX) ...

Definition at line 87 of file msg_parser.c.

Referenced by build_req_buf_from_sip_req(), and fix_global_req_flags().

msg_parser.h File Reference