Collaboration diagram for Max-Forwards Header:
![]() |
The Max-Forwards syntax is defined in [S10.27] as follows:
Max-Forwards = "Max-Forwards" HCOLON 1*DIGIT
Data Structures | |
struct | sip_max_forwards_s |
Structure for Max-Forwards header. More... | |
Defines | |
#define | sip_max_forwards(sip) |
Access a sip_max_forwards_t from sip_t. | |
#define | SIP_MAX_FORWARDS_INIT() |
Initializer for structure sip_max_forwards_t. | |
#define | SIPTAG_MAX_FORWARDS(x) |
Tag list item for pointer to a Max-Forwards header structure. | |
#define | SIPTAG_MAX_FORWARDS_REF(x) |
Tag list item for reference to a a Max-Forwards header pointer. | |
#define | SIPTAG_MAX_FORWARDS_STR(s) |
Tag list item for string with Max-Forwards header value. | |
#define | SIPTAG_MAX_FORWARDS_STR_REF(x) |
Tag list item for reference to a a Max-Forwards header string. | |
Typedefs | |
typedef sip_max_forwards_s | sip_max_forwards_t |
The structure sip_max_forwards_t contains representation of SIP Max-Forwards header. | |
Enumerator | |
sip_max_forwards_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_max_forwards_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Max-Forwards header. | |
SOFIAPUBFUN int | sip_max_forwards_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Max-Forwards header. | |
sip_max_forwards_t * | sip_max_forwards_init (sip_max_forwards_t x[1]) |
Initialize a structure sip_max_forwards_t. | |
int | sip_is_max_forwards (sip_header_t const *header) |
Test if header object is instance of sip_max_forwards_t. | |
sip_max_forwards_t * | sip_max_forwards_dup (su_home_t *home, sip_max_forwards_t const *hdr)) |
Duplicate (deep copy) sip_max_forwards_t . | |
sip_max_forwards_t * | sip_max_forwards_copy (su_home_t *home, sip_max_forwards_t const *hdr)) |
Copy a sip_max_forwards_t header structure. | |
sip_max_forwards_t * | sip_max_forwards_make (su_home_t *home, char const *s)) |
Make a header structure sip_max_forwards_t. | |
sip_max_forwards_t * | sip_max_forwards_format (su_home_t *home, char const *fmt,...))) |
Make a Max-Forwards header from formatting result. | |
Variables | |
tag_typedef_t | siptag_max_forwards |
Tag for Max-Forwards header object. | |
tag_typedef_t | siptag_max_forwards_str |
Tag for string with Max-Forwards header value. | |
msg_hclass_t | sip_max_forwards_class [] |
Header class for SIP Max-Forwards header. |
#define SIP_MAX_FORWARDS_INIT | ( | ) |
Initializer for structure sip_max_forwards_t.
A static sip_max_forwards_t structure must be initialized. The SIP_MAX_FORWARDS_INIT() macro provides initialization value. For instance,
#define SIPTAG_MAX_FORWARDS | ( | x | ) |
Tag list item for pointer to a Max-Forwards header structure.
The SIPTAG_MAX_FORWARDS() macro is used to include a tag item with a pointer to a sip_max_forwards_t object in a tag list.
x | pointer to a sip_max_forwards_t header structure, or NULL. |
#define SIPTAG_MAX_FORWARDS_STR | ( | s | ) |
Tag list item for string with Max-Forwards header value.
The SIPTAG_MAX_FORWARDS_STR() macro is used to include a tag item with a string containing value of a sip_max_forwards_t header in a tag list.
s | pointer to a string containing sip_max_forwards_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_MAX_FORWARDS_STR_REF().
typedef struct sip_max_forwards_s sip_max_forwards_t |
The structure sip_max_forwards_t contains representation of SIP Max-Forwards header.
The sip_max_forwards_t is defined as follows:
typedef struct sip_max_forwards_s { sip_common_t mf_common[1]; // Common fragment info sip_unknown_t *mf_next; // Link to next (dummy) unsigned long mf_count; // Digits } sip_max_forwards_t;
sip_max_forwards_hash |
@
Hash of Max-Forwards header.
int sip_is_max_forwards | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_max_forwards_t.
The function sip_is_max_forwards() returns true (nonzero) if the header class is an instance of Max-Forwards header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_max_forwards_t * sip_max_forwards_copy | ( | su_home_t * | home, | |
sip_max_forwards_t const * | hdr | |||
) | [inline] |
Copy a sip_max_forwards_t header structure.
The function sip_max_forwards_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 header structure hdr.
home | memory home used to allocate new structure | |
hdr | pointer to the header structure to be copied |
max_forwards = sip_max_forwards_copy(home, sip->sip_max_forwards);
sip_max_forwards_t * sip_max_forwards_dup | ( | su_home_t * | home, | |
sip_max_forwards_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_max_forwards_t
.
The function sip_max_forwards_dup() duplicates 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.
home | memory home used to allocate new structure | |
hdr | header structure to be duplicated |
max_forwards = sip_max_forwards_dup(home, sip->sip_max_forwards);
sip_max_forwards_t * sip_max_forwards_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Max-Forwards header from formatting result.
The function sip_max_forwards_format() makes a new Max-Forwards header 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 uses the formatting result as the header value.
home | memory home used to allocate new header structure. | |
fmt | string used as a printf()-style format | |
... | argument list for format |
sip_max_forwards_t* sip_max_forwards_init | ( | sip_max_forwards_t | x[1] | ) | [inline] |
Initialize a structure sip_max_forwards_t.
An sip_max_forwards_t structure can be initialized with the sip_max_forwards_init() function/macro. For instance,
sip_max_forwards_t * sip_max_forwards_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_max_forwards_t.
The function sip_max_forwards_make() makes a new sip_max_forwards_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.
home | memory home used to allocate new header structure. | |
s | string to be decoded as value of the new header structure |
Header class for SIP Max-Forwards header.
The header class sip_max_forwards_class defines how a SIP Max-Forwards header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_max_forwards_t header structure.