Collaboration diagram for In-Reply-To Header:
![]() |
Its syntax is defined in [S10.26] as follows:
In-Reply-To = "In-Reply-To" HCOLON callid *(COMMA callid)
Defines | |
#define | sip_in_reply_to(sip) |
Access a sip_in_reply_to_t from sip_t. | |
#define | SIP_IN_REPLY_TO_INIT() |
Initializer for structure sip_in_reply_to_t. | |
#define | SIPTAG_IN_REPLY_TO(x) |
Tag list item for pointer to a In-Reply-To header structure. | |
#define | SIPTAG_IN_REPLY_TO_REF(x) |
Tag list item for reference to a a In-Reply-To header pointer. | |
#define | SIPTAG_IN_REPLY_TO_STR(s) |
Tag list item for string with In-Reply-To header value. | |
#define | SIPTAG_IN_REPLY_TO_STR_REF(x) |
Tag list item for reference to a a In-Reply-To header string. | |
Enumerator | |
sip_in_reply_to_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_in_reply_to_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a In-Reply-To header. | |
SOFIAPUBFUN int | sip_in_reply_to_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a In-Reply-To header. | |
sip_in_reply_to_t * | sip_in_reply_to_init (sip_in_reply_to_t x[1]) |
Initialize a structure sip_in_reply_to_t. | |
int | sip_is_in_reply_to (sip_header_t const *header) |
Test if header object is instance of sip_in_reply_to_t. | |
sip_in_reply_to_t * | sip_in_reply_to_dup (su_home_t *home, sip_in_reply_to_t const *hdr)) |
Duplicate (deep copy) sip_in_reply_to_t . | |
sip_in_reply_to_t * | sip_in_reply_to_copy (su_home_t *home, sip_in_reply_to_t const *hdr)) |
Copy a sip_in_reply_to_t header structure. | |
sip_in_reply_to_t * | sip_in_reply_to_make (su_home_t *home, char const *s)) |
Make a header structure sip_in_reply_to_t. | |
sip_in_reply_to_t * | sip_in_reply_to_format (su_home_t *home, char const *fmt,...))) |
Make a In-Reply-To header from formatting result. | |
Variables | |
tag_typedef_t | siptag_in_reply_to |
Tag for In-Reply-To header object. | |
tag_typedef_t | siptag_in_reply_to_str |
Tag for string with In-Reply-To header value. | |
msg_hclass_t | sip_in_reply_to_class [] |
Header class for SIP In-Reply-To header. |
#define SIP_IN_REPLY_TO_INIT | ( | ) |
Initializer for structure sip_in_reply_to_t.
A static sip_in_reply_to_t structure must be initialized. The SIP_IN_REPLY_TO_INIT() macro provides initialization value. For instance,
sip_in_reply_to_t sip_in_reply_to = SIP_IN_REPLY_TO_INIT;
#define SIPTAG_IN_REPLY_TO | ( | x | ) |
Tag list item for pointer to a In-Reply-To header structure.
The SIPTAG_IN_REPLY_TO() macro is used to include a tag item with a pointer to a sip_in_reply_to_t object in a tag list.
x | pointer to a sip_in_reply_to_t header structure, or NULL. |
#define SIPTAG_IN_REPLY_TO_STR | ( | s | ) |
Tag list item for string with In-Reply-To header value.
The SIPTAG_IN_REPLY_TO_STR() macro is used to include a tag item with a string containing value of a sip_in_reply_to_t header in a tag list.
s | pointer to a string containing sip_in_reply_to_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_IN_REPLY_TO_STR_REF().
sip_in_reply_to_hash |
@
Hash of In-Reply-To header.
sip_in_reply_to_t * sip_in_reply_to_copy | ( | su_home_t * | home, | |
sip_in_reply_to_t const * | hdr | |||
) | [inline] |
Copy a sip_in_reply_to_t header structure.
The function sip_in_reply_to_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 |
in_reply_to = sip_in_reply_to_copy(home, sip->sip_in_reply_to);
sip_in_reply_to_t * sip_in_reply_to_dup | ( | su_home_t * | home, | |
sip_in_reply_to_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_in_reply_to_t
.
The function sip_in_reply_to_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 |
in_reply_to = sip_in_reply_to_dup(home, sip->sip_in_reply_to);
sip_in_reply_to_t * sip_in_reply_to_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a In-Reply-To header from formatting result.
The function sip_in_reply_to_format() makes a new In-Reply-To 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_in_reply_to_t* sip_in_reply_to_init | ( | sip_in_reply_to_t | x[1] | ) | [inline] |
Initialize a structure sip_in_reply_to_t.
An sip_in_reply_to_t structure can be initialized with the sip_in_reply_to_init() function/macro. For instance,
sip_in_reply_to_t sip_in_reply_to; sip_in_reply_to_init(&sip_in_reply_to);
sip_in_reply_to_t * sip_in_reply_to_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_in_reply_to_t.
The function sip_in_reply_to_make() makes a new sip_in_reply_to_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 |
int sip_is_in_reply_to | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_in_reply_to_t.
The function sip_is_in_reply_to() returns true (nonzero) if the header class is an instance of In-Reply-To header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP In-Reply-To header.
The header class sip_in_reply_to_class defines how a SIP In-Reply-To header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_in_reply_to_t header structure.