Collaboration diagram for Replaces Header:
![]() |
Its syntax is defined in RFC 3891 section 6.1 as follows:
Replaces = "Replaces" HCOLON callid *(SEMI replaces-param) replaces-param = to-tag / from-tag / early-flag / generic-param to-tag = "to-tag" EQUAL token from-tag = "from-tag" EQUAL token early-flag = "early-only"
A Replaces header field MUST contain exactly one to-tag and exactly one from-tag, as they are required for unique dialog matching. For compatibility with dialogs initiated by RFC 2543 compliant UAs, a tag of zero matches both tags of zero and null. A Replaces header field MAY contain the early-flag.
Data Structures | |
struct | sip_replaces_s |
Structure for Replaces header. More... | |
Defines | |
#define | sip_replaces(sip) |
Access a sip_replaces_t from sip_t. | |
#define | SIP_REPLACES_INIT() |
Initializer for structure sip_replaces_t. | |
#define | SIPTAG_REPLACES(x) |
Tag list item for pointer to a Replaces header structure. | |
#define | SIPTAG_REPLACES_REF(x) |
Tag list item for reference to a a Replaces header pointer. | |
#define | SIPTAG_REPLACES_STR(s) |
Tag list item for string with Replaces header value. | |
#define | SIPTAG_REPLACES_STR_REF(x) |
Tag list item for reference to a a Replaces header string. | |
Typedefs | |
typedef sip_replaces_s | sip_replaces_t |
The structure sip_replaces_t contains representation of Replaces header. | |
Enumerator | |
sip_replaces_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_replaces_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Replaces header. | |
SOFIAPUBFUN int | sip_replaces_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Replaces header. | |
sip_replaces_t * | sip_replaces_init (sip_replaces_t x[1]) |
Initialize a structure sip_replaces_t. | |
int | sip_is_replaces (sip_header_t const *header) |
Test if header object is instance of sip_replaces_t. | |
sip_replaces_t * | sip_replaces_dup (su_home_t *home, sip_replaces_t const *hdr)) |
Duplicate (deep copy) sip_replaces_t . | |
sip_replaces_t * | sip_replaces_copy (su_home_t *home, sip_replaces_t const *hdr)) |
Copy a sip_replaces_t header structure. | |
sip_replaces_t * | sip_replaces_make (su_home_t *home, char const *s)) |
Make a header structure sip_replaces_t. | |
sip_replaces_t * | sip_replaces_format (su_home_t *home, char const *fmt,...))) |
Make a Replaces header from formatting result. | |
Variables | |
tag_typedef_t | siptag_replaces |
Tag for Replaces header object. | |
tag_typedef_t | siptag_replaces_str |
Tag for string with Replaces header value. | |
msg_hclass_t | sip_replaces_class [] |
Header class for SIP Replaces header. |
#define SIP_REPLACES_INIT | ( | ) |
Initializer for structure sip_replaces_t.
A static sip_replaces_t structure must be initialized. The SIP_REPLACES_INIT() macro provides initialization value. For instance,
#define SIPTAG_REPLACES | ( | x | ) |
Tag list item for pointer to a Replaces header structure.
The SIPTAG_REPLACES() macro is used to include a tag item with a pointer to a sip_replaces_t object in a tag list.
x | pointer to a sip_replaces_t header structure, or NULL. |
#define SIPTAG_REPLACES_STR | ( | s | ) |
Tag list item for string with Replaces header value.
The SIPTAG_REPLACES_STR() macro is used to include a tag item with a string containing value of a sip_replaces_t header in a tag list.
s | pointer to a string containing sip_replaces_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_REPLACES_STR_REF().
typedef struct sip_replaces_s sip_replaces_t |
The structure sip_replaces_t contains representation of Replaces header.
The sip_replaces_t is defined as follows:
typedef struct sip_replaces_s { sip_common_t rp_common[1]; // Common fragment info sip_error_t *rp_next; // Link to next (dummy) char const *rp_call_id; // Call-ID msg_param_t const *rp_params; // List of parameters msg_param_t rp_to_tag; // to-tag parameter msg_param_t rp_from_tag; // from-tag parameter int rp_early_only; // early-only parameter } sip_replaces_t;
sip_replaces_hash |
@
Hash of Replaces header.
int sip_is_replaces | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_replaces_t.
The function sip_is_replaces() returns true (nonzero) if the header class is an instance of Replaces header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_replaces_t * sip_replaces_copy | ( | su_home_t * | home, | |
sip_replaces_t const * | hdr | |||
) | [inline] |
Copy a sip_replaces_t header structure.
The function sip_replaces_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 |
replaces = sip_replaces_copy(home, sip->sip_replaces);
sip_replaces_t * sip_replaces_dup | ( | su_home_t * | home, | |
sip_replaces_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_replaces_t
.
The function sip_replaces_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 |
replaces = sip_replaces_dup(home, sip->sip_replaces);
sip_replaces_t * sip_replaces_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Replaces header from formatting result.
The function sip_replaces_format() makes a new Replaces 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_replaces_t* sip_replaces_init | ( | sip_replaces_t | x[1] | ) | [inline] |
Initialize a structure sip_replaces_t.
An sip_replaces_t structure can be initialized with the sip_replaces_init() function/macro. For instance,
sip_replaces_t * sip_replaces_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_replaces_t.
The function sip_replaces_make() makes a new sip_replaces_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 Replaces header.
The header class sip_replaces_class defines how a SIP Replaces header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_replaces_t header structure.