Collaboration diagram for RSeq Header:
![]() |
Its syntax is defined in draft-ietf-sip-100rel-04.txt section 5 as follows:
RSeq = "RSeq" ":" response-num response-num = 1*DIGIT
Data Structures | |
struct | sip_rseq_s |
Structure for RSeq header. More... | |
Defines | |
#define | sip_rseq(sip) |
Access a sip_rseq_t from sip_t. | |
#define | SIP_RSEQ_INIT() |
Initializer for structure sip_rseq_t. | |
#define | SIPTAG_RSEQ(x) |
Tag list item for pointer to a RSeq header structure. | |
#define | SIPTAG_RSEQ_REF(x) |
Tag list item for reference to a a RSeq header pointer. | |
#define | SIPTAG_RSEQ_STR(s) |
Tag list item for string with RSeq header value. | |
#define | SIPTAG_RSEQ_STR_REF(x) |
Tag list item for reference to a a RSeq header string. | |
Enumerator | |
sip_rseq_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_rseq_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a RSeq header. | |
SOFIAPUBFUN int | sip_rseq_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a RSeq header. | |
sip_rseq_t * | sip_rseq_init (sip_rseq_t x[1]) |
Initialize a structure sip_rseq_t. | |
int | sip_is_rseq (sip_header_t const *header) |
Test if header object is instance of sip_rseq_t. | |
sip_rseq_t * | sip_rseq_dup (su_home_t *home, sip_rseq_t const *hdr)) |
Duplicate (deep copy) sip_rseq_t . | |
sip_rseq_t * | sip_rseq_copy (su_home_t *home, sip_rseq_t const *hdr)) |
Copy a sip_rseq_t header structure. | |
sip_rseq_t * | sip_rseq_make (su_home_t *home, char const *s)) |
Make a header structure sip_rseq_t. | |
sip_rseq_t * | sip_rseq_format (su_home_t *home, char const *fmt,...))) |
Make a RSeq header from formatting result. | |
Variables | |
tag_typedef_t | siptag_rseq |
Tag for RSeq header object. | |
tag_typedef_t | siptag_rseq_str |
Tag for string with RSeq header value. | |
msg_hclass_t | sip_rseq_class [] |
Header class for SIP RSeq header. |
#define SIP_RSEQ_INIT | ( | ) |
Initializer for structure sip_rseq_t.
A static sip_rseq_t structure must be initialized. The SIP_RSEQ_INIT() macro provides initialization value. For instance,
#define SIPTAG_RSEQ | ( | x | ) |
Tag list item for pointer to a RSeq header structure.
The SIPTAG_RSEQ() macro is used to include a tag item with a pointer to a sip_rseq_t object in a tag list.
x | pointer to a sip_rseq_t header structure, or NULL. |
#define SIPTAG_RSEQ_STR | ( | s | ) |
Tag list item for string with RSeq header value.
The SIPTAG_RSEQ_STR() macro is used to include a tag item with a string containing value of a sip_rseq_t header in a tag list.
s | pointer to a string containing sip_rseq_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_RSEQ_STR_REF().
sip_rseq_hash |
@
Hash of RSeq header.
int sip_is_rseq | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_rseq_t.
The function sip_is_rseq() returns true (nonzero) if the header class is an instance of RSeq header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_rseq_t * sip_rseq_copy | ( | su_home_t * | home, | |
sip_rseq_t const * | hdr | |||
) | [inline] |
Copy a sip_rseq_t header structure.
The function sip_rseq_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 |
rseq = sip_rseq_copy(home, sip->sip_rseq);
sip_rseq_t * sip_rseq_dup | ( | su_home_t * | home, | |
sip_rseq_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_rseq_t
.
The function sip_rseq_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 |
rseq = sip_rseq_dup(home, sip->sip_rseq);
sip_rseq_t * sip_rseq_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a RSeq header from formatting result.
The function sip_rseq_format() makes a new RSeq 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_rseq_t* sip_rseq_init | ( | sip_rseq_t | x[1] | ) | [inline] |
Initialize a structure sip_rseq_t.
An sip_rseq_t structure can be initialized with the sip_rseq_init() function/macro. For instance,
sip_rseq_t * sip_rseq_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_rseq_t.
The function sip_rseq_make() makes a new sip_rseq_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 RSeq header.
The header class sip_rseq_class defines how a SIP RSeq header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_rseq_t header structure.