Parser :: Generic Parameter Parser. More...

#include <stdio.h>
#include "../str.h"

Include dependency graph for parse_param.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct contact_hooks
Hooks to well known parameters for contact class of parameters. More...
struct param
Structure representing a parameter. More...
union param_hooks
Union of hooks structures for all classes. More...
struct uri_hooks
Hooks to well known parameter for URI class of parameters. More...

Typedefs

typedef union param_hooks param_hooks_t
Union of hooks structures for all classes.
typedef struct param param_t
Structure representing a parameter.
typedef enum pclass pclass_t
Class of parameters.
typedef enum ptype ptype_t
Supported types of parameters.

Enumerations

enum pclass { CLASS_ANY = 0, CLASS_CONTACT, CLASS_URI, CLASS_EVENT_DIALOG }
Class of parameters.
More...
enum ptype {
  P_OTHER = 0, P_Q, P_EXPIRES, P_METHODS,
  P_RECEIVED, P_TRANSPORT, P_LR, P_R2,
  P_MADDR, P_TTL, P_DSTIP, P_DSTPORT,
  P_INSTANCE, P_REG_ID, P_FTAG, P_CALL_ID,
  P_FROM_TAG, P_TO_TAG, P_ISD, P_SLA,
  P_MA
}
Supported types of parameters.
More...

Functions

int duplicate_params (param_t **_n, param_t *_p)
Duplicate linked list of parameters.
void free_params (param_t *_p)
Free linked list of parameters.
int parse_param (str *_s, pclass_t _c, param_hooks_t *_h, param_t *t)
Only parse one parameter.
int parse_params (str *_s, pclass_t _c, param_hooks_t *_h, param_t **_p)
Parse parameters.
void print_params (FILE *_o, param_t *_p)
Print linked list of parameters, just for debugging.
int shm_duplicate_params (param_t **_n, param_t *_p)
Duplicate linked list of parameters.
void shm_free_params (param_t *_p)
Free linked list of parameters from shared memory.

Detailed Description

Definition in file parse_param.h.

Enumeration Type Documentation

enum pclass

Enumerator:

CLASS_ANY	Any parameters, well-known hooks will be not used.
CLASS_CONTACT	Contact parameters.
CLASS_URI	URI parameters.
CLASS_EVENT_DIALOG	Event dialog parameters.

Definition at line 79 of file parse_param.h.

enum ptype

Enumerator:

P_OTHER	Unknown parameter.
P_Q	Contact: q parameter.
P_EXPIRES	Contact: expires parameter.
P_METHODS	Contact: methods parameter.
P_RECEIVED	Contact: received parameter.
P_TRANSPORT	URI: transport parameter.
P_LR	URI: lr parameter.
P_R2	URI: r2 parameter (ser specific).
P_MADDR	URI: maddr parameter.
P_TTL	URI: ttl parameter.
P_DSTIP	URI: dstip parameter.
P_DSTPORT	URi: dstport parameter.
P_INSTANCE	Contact: sip.instance parameter.
P_REG_ID	Contact: reg-id parameter.
P_FTAG	URI: ftag parameter.
P_CALL_ID	Dialog event package: call-id.
P_FROM_TAG	Dialog event package: from-tag.
P_TO_TAG	Dialog event package: to-tag.
P_ISD	Dialog event package: include-session-description.
P_SLA	Dialog event package: sla.
P_MA	Dialog event package: ma.

Definition at line 51 of file parse_param.h.

Function Documentation

int parse_param	(	str *	_s,
		pclass_t	_c,
		param_hooks_t *	_h,
		param_t *	t
	)			`[inline]`

Returns:: : t: out parameter -1: on error 0: success, but expect a next paramter 1: success and exepect no more parameters

Definition at line 442 of file parse_param.c.

References param::body, param::len, _str::len, param::name, parse_param_body(), parse_param_name(), and _str::s.

Referenced by parse_params().

Here is the call graph for this function:

Here is the caller graph for this function:

int parse_params	(	str *	_s,
		pclass_t	_c,
		param_hooks_t *	_h,
		param_t **	_p
	)

Parameters:

	_s	is string containing parameters
	_c	is class of parameters
	_h	is pointer to structure that will be filled with pointer to well known parameters linked list of parsed parameters will be stored in the variable _p is pointing to

Returns:: The function returns 0 on success and negative number on an error