Proxy-Require Header [SIP Headers]

The Proxy-Require header is used to indicate proxy-sensitive features that MUST be supported by the proxy. More...

Defines
#define	sip_proxy_require(sip)
	Access a SIP Proxy-Require header structure sip_proxy_require_t from sip_t.
#define	SIP_PROXY_REQUIRE_INIT()
	Initializer for structure sip_proxy_require_t.
#define	SIPTAG_PROXY_REQUIRE(x)
	Tag list item for pointer to a Proxy-Require header structure sip_proxy_require_t.
#define	SIPTAG_PROXY_REQUIRE_REF(x)
	Tag list item for reference to a Proxy-Require header pointer.
#define	SIPTAG_PROXY_REQUIRE_STR(s)
	Tag list item for string with Proxy-Require header value.
#define	SIPTAG_PROXY_REQUIRE_STR_REF(x)
	Tag list item for reference to a Proxy-Require header string.
Typedefs
typedef msg_list_t	sip_proxy_require_t
	The structure sip_proxy_require_t contains representation of an Proxy-Require header.
Functions
issize_t	sip_proxy_require_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
	Parse a SIP Proxy-Require header.
issize_t	sip_proxy_require_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
	Print a SIP Proxy-Require header.
sip_proxy_require_t *	sip_proxy_require_init (sip_proxy_require_t x[1])
	Initialize a structure sip_proxy_require_t.
int	sip_is_proxy_require (sip_header_t const *header)
	Test if header object is instance of sip_proxy_require_t.
sip_proxy_require_t *	sip_proxy_require_dup (su_home_t *home, sip_proxy_require_t const *hdr))
	Duplicate a list of Proxy-Require header header structures sip_proxy_require_t.
sip_proxy_require_t *	sip_proxy_require_copy (su_home_t *home, sip_proxy_require_t const *hdr))
	Copy a list of Proxy-Require header header structures sip_proxy_require_t.
sip_proxy_require_t *	sip_proxy_require_make (su_home_t *home, char const *s))
	Make a Proxy-Require header structure sip_proxy_require_t.
sip_proxy_require_t *	sip_proxy_require_format (su_home_t *home, char const *fmt,...)))
	Make a Proxy-Require header from formatting result.
Variables
msg_hclass_t	sip_proxy_require_class []
	Header class for Proxy-Require header.
tag_typedef_t	siptag_proxy_require
	Tag for Proxy-Require header object.
tag_typedef_t	siptag_proxy_require_str
	Tag for string with Proxy-Require header value.

---

Detailed Description

The Proxy-Require header is used to indicate proxy-sensitive features that MUST be supported by the proxy.

Its syntax is defined in RFC 3261 as follows:

    Proxy-Require  =  "Proxy-Require" HCOLON option-tag *(COMMA option-tag)

The parsed Proxy-Require header is stored in sip_proxy_require_t structure.

---

Define Documentation

#define SIP_PROXY_REQUIRE_INIT

(

)

Initializer for structure sip_proxy_require_t.

A static sip_proxy_require_t structure for Proxy-Require header must be initialized with the SIP_PROXY_REQUIRE_INIT() macro. For instance,

  sip_proxy_require_t sip_proxy_require = SIP_PROXY_REQUIRE_INIT;

#define SIPTAG_PROXY_REQUIRE

(

x

)

Tag list item for pointer to a Proxy-Require header structure sip_proxy_require_t.

The SIPTAG_PROXY_REQUIRE() macro is used to include a tag item with a pointer to a sip_proxy_require_t structure in a tag list.

Parameters:

x

pointer to a sip_proxy_require_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_PROXY_REQUIRE_REF().

#define SIPTAG_PROXY_REQUIRE_STR

(

s

)

Tag list item for string with Proxy-Require header value.

The SIPTAG_PROXY_REQUIRE_STR() macro is used to include a tag item with a string containing value of a sip_proxy_require_t header in a tag list.

Parameters:

s

pointer to a string containing Proxy-Require header value, or NULL.

The string in SIPTAG_PROXY_REQUIRE_STR() can be converted to a sip_proxy_require_t header structure by giving the string s has second argument to function sip_proxy_require_make().

The corresponding tag taking reference parameter is SIPTAG_PROXY_REQUIRE_STR_REF().

---

Typedef Documentation

struct msg_list_s sip_proxy_require_t

The structure sip_proxy_require_t contains representation of an Proxy-Require header.

The sip_proxy_require_t is defined as follows:

 typedef struct msg_list_s
 {
   msg_common_t       k_common[1];  // Common fragment info
   msg_list_t        *k_next;         // Dummy link
   msg_param_t       *k_items;      // List of items
 } sip_proxy_require_t;

---

Function Documentation

int sip_is_proxy_require

(

sip_header_t const *

header

)

[inline]

Test if header object is instance of sip_proxy_require_t.

Check if the header class is an instance of Proxy-Require header object and return true (nonzero), otherwise return false (zero).

Parameters:

header

pointer to the header structure to be tested

Return values:

	1	(true) if the header is an instance of header proxy_require
	0	(false) otherwise

sip_proxy_require_t * sip_proxy_require_copy	(	su_home_t *	home,
		sip_proxy_require_t const *	hdr
	)			[inline]

Copy a list of Proxy-Require header header structures sip_proxy_require_t.

The function sip_proxy_require_copy() copies a header structure hdr. If the header structure hdr contains a reference (hdr->h_next) to a list of headers, all the headers in that list are copied, too. The function uses given memory home to allocate all the memory areas used to copy the list of header structure hdr.

Parameters:

	home	memory home used to allocate new structure
	hdr	pointer to the header structure to be copied

When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old hdr header, including the encoding of the old header, if present.

Example

   proxy_require = sip_proxy_require_copy(home, sip->sip_proxy_require);

Returns:

A pointer to newly copied header structure, or NULL upon an error.

sip_proxy_require_t * sip_proxy_require_dup	(	su_home_t *	home,
		sip_proxy_require_t const *	hdr
	)			[inline]

Duplicate a list of Proxy-Require header header structures sip_proxy_require_t.

Duplicate a header structure hdr. If the header structure hdr contains a reference (hdr->x_next) to a list of headers, all the headers in the list are duplicated, too.

Parameters:

	home	memory home used to allocate new structure
	hdr	header structure to be duplicated

When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.

Example

   proxy_require = sip_proxy_require_dup(home, sip->sip_proxy_require);

Returns:

A pointer to the newly duplicated sip_proxy_require_t header structure, or NULL upon an error.

sip_proxy_require_t * sip_proxy_require_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Proxy-Require header from formatting result.

Make a new sip_proxy_require_t object using formatting result as its value. The function first prints the arguments according to the format fmt specified. Then it allocates a new header structure, and parses the formatting result to the structure sip_proxy_require_t.

Parameters:

	home	memory home used to allocate new header structure.
	fmt	string used as a printf()-style format
	...	argument list for format

Returns:

A pointer to newly makes header structure, or NULL upon an error.

sip_proxy_require_t* sip_proxy_require_init

(

sip_proxy_require_t

x[1]

)

[inline]

Initialize a structure sip_proxy_require_t.

An sip_proxy_require_t structure for Proxy-Require header can be initialized with the sip_proxy_require_init() function/macro. For instance,

  sip_proxy_require_t sip_proxy_require;

  sip_proxy_require_init(&sip_proxy_require);

sip_proxy_require_t * sip_proxy_require_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a Proxy-Require header structure sip_proxy_require_t.

The function sip_proxy_require_make() makes a new sip_proxy_require_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters:

	home	memory home used to allocate new header structure.
	s	string to be decoded as value of the new header structure

Returns:

A pointer to newly maked sip_proxy_require_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t sip_proxy_require_class[]

Header class for Proxy-Require header.

The header class sip_proxy_require_class defines how a SIP Proxy-Require header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_proxy_require_t header structure.