Collaboration diagram for Request-Disposition Header:
![]() |
Request-Disposition = ( "Request-Disposition" | "d" ) HCOLON directive *(COMMA directive) directive = proxy-directive / cancel-directive / fork-directive / recurse-directive / parallel-directive / queue-directive) proxy-directive = "proxy" / "redirect" cancel-directive = "cancel" / "no-cancel" fork-directive = "fork" / "no-fork" recurse-directive = "recurse" / "no-recurse" parallel-directive = "parallel" / "sequential" queue-directive = "queue" / "no-queue"
Data Structures | |
struct | sip_request_disposition_s |
Structure for Request-Disposition header. More... | |
Defines | |
#define | sip_request_disposition(sip) |
Access a sip_request_disposition_t from sip_t. | |
#define | SIP_REQUEST_DISPOSITION_INIT() |
Initializer for structure sip_request_disposition_t. | |
#define | SIPTAG_REQUEST_DISPOSITION(x) |
Tag list item for pointer to a Request-Disposition header structure. | |
#define | SIPTAG_REQUEST_DISPOSITION_REF(x) |
Tag list item for reference to a a Request-Disposition header pointer. | |
#define | SIPTAG_REQUEST_DISPOSITION_STR(s) |
Tag list item for string with Request-Disposition header value. | |
#define | SIPTAG_REQUEST_DISPOSITION_STR_REF(x) |
Tag list item for reference to a a Request-Disposition header string. | |
Typedefs | |
typedef sip_request_disposition_s | sip_request_disposition_t |
The structure sip_request_disposition_t contains representation of Request-Disposition header. | |
Enumerator | |
sip_request_disposition_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_request_disposition_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Request-Disposition header. | |
SOFIAPUBFUN int | sip_request_disposition_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Request-Disposition header. | |
sip_request_disposition_t * | sip_request_disposition_init (sip_request_disposition_t x[1]) |
Initialize a structure sip_request_disposition_t. | |
int | sip_is_request_disposition (sip_header_t const *header) |
Test if header object is instance of sip_request_disposition_t. | |
sip_request_disposition_t * | sip_request_disposition_dup (su_home_t *home, sip_request_disposition_t const *hdr)) |
Duplicate (deep copy) sip_request_disposition_t . | |
sip_request_disposition_t * | sip_request_disposition_copy (su_home_t *home, sip_request_disposition_t const *hdr)) |
Copy a sip_request_disposition_t header structure. | |
sip_request_disposition_t * | sip_request_disposition_make (su_home_t *home, char const *s)) |
Make a header structure sip_request_disposition_t. | |
sip_request_disposition_t * | sip_request_disposition_format (su_home_t *home, char const *fmt,...))) |
Make a Request-Disposition header from formatting result. | |
Variables | |
tag_typedef_t | siptag_request_disposition |
Tag for Request-Disposition header object. | |
tag_typedef_t | siptag_request_disposition_str |
Tag for string with Request-Disposition header value. | |
msg_hclass_t | sip_request_disposition_class [] |
Header class for SIP Request-Disposition header. |
#define SIP_REQUEST_DISPOSITION_INIT | ( | ) |
Initializer for structure sip_request_disposition_t.
A static sip_request_disposition_t structure must be initialized. The SIP_REQUEST_DISPOSITION_INIT() macro provides initialization value. For instance,
#define SIPTAG_REQUEST_DISPOSITION | ( | x | ) |
Tag list item for pointer to a Request-Disposition header structure.
The SIPTAG_REQUEST_DISPOSITION() macro is used to include a tag item with a pointer to a sip_request_disposition_t object in a tag list.
x | pointer to a sip_request_disposition_t header structure, or NULL. |
#define SIPTAG_REQUEST_DISPOSITION_STR | ( | s | ) |
Tag list item for string with Request-Disposition header value.
The SIPTAG_REQUEST_DISPOSITION_STR() macro is used to include a tag item with a string containing value of a sip_request_disposition_t header in a tag list.
s | pointer to a string containing sip_request_disposition_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_REQUEST_DISPOSITION_STR_REF().
typedef struct sip_request_disposition_s sip_request_disposition_t |
The structure sip_request_disposition_t contains representation of Request-Disposition header.
The sip_request_disposition_t is defined as follows:
typedef struct sip_request_disposition_s { sip_common_t rd_common[1]; // Common fragment info sip_unknown_t *rd_next; // Link to next (dummy) msg_param_t *rd_items; } sip_request_disposition_t;
sip_request_disposition_hash |
@
Hash of Request-Disposition header.
int sip_is_request_disposition | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_request_disposition_t.
The function sip_is_request_disposition() returns true (nonzero) if the header class is an instance of Request-Disposition header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_request_disposition_t * sip_request_disposition_copy | ( | su_home_t * | home, | |
sip_request_disposition_t const * | hdr | |||
) | [inline] |
Copy a sip_request_disposition_t header structure.
The function sip_request_disposition_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 |
request_disposition = sip_request_disposition_copy(home, sip->sip_request_disposition);
sip_request_disposition_t * sip_request_disposition_dup | ( | su_home_t * | home, | |
sip_request_disposition_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_request_disposition_t
.
The function sip_request_disposition_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 |
request_disposition = sip_request_disposition_dup(home, sip->sip_request_disposition);
sip_request_disposition_t * sip_request_disposition_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Request-Disposition header from formatting result.
The function sip_request_disposition_format() makes a new Request-Disposition 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_request_disposition_t* sip_request_disposition_init | ( | sip_request_disposition_t | x[1] | ) | [inline] |
Initialize a structure sip_request_disposition_t.
An sip_request_disposition_t structure can be initialized with the sip_request_disposition_init() function/macro. For instance,
sip_request_disposition_t * sip_request_disposition_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_request_disposition_t.
The function sip_request_disposition_make() makes a new sip_request_disposition_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 Request-Disposition header.
The header class sip_request_disposition_class defines how a SIP Request-Disposition header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_request_disposition_t header structure.