Collaboration diagram for Reason Header:
![]() |
It can be used with HRPF scenarios. It is defined in RFC 3326 as follows:
Reason = "Reason" HCOLON reason-value *(COMMA reason-value)
reason-value = protocol *(SEMI reason-params)
protocol = "SIP" / "Q.850" / token
reason-params = protocol-cause / reason-text
/ reason-extension
protocol-cause = "cause" EQUAL cause
cause = 1*DIGIT
reason-text = "text" EQUAL quoted-string
reason-extension = generic-param
Data Structures | |
struct | sip_reason_s |
Structure for Reason header. More... | |
Defines | |
#define | sip_reason(sip) |
Access a sip_reason_t from sip_t. | |
#define | SIP_REASON_INIT() |
Initializer for structure sip_reason_t. | |
#define | SIPTAG_REASON(x) |
Tag list item for pointer to a Reason header structure. | |
#define | SIPTAG_REASON_REF(x) |
Tag list item for reference to a a Reason header pointer. | |
#define | SIPTAG_REASON_STR(s) |
Tag list item for string with Reason header value. | |
#define | SIPTAG_REASON_STR_REF(x) |
Tag list item for reference to a a Reason header string. | |
Enumerator | |
sip_reason_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_reason_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Reason header. | |
SOFIAPUBFUN int | sip_reason_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Reason header. | |
sip_reason_t * | sip_reason_init (sip_reason_t x[1]) |
Initialize a structure sip_reason_t. | |
int | sip_is_reason (sip_header_t const *header) |
Test if header object is instance of sip_reason_t. | |
sip_reason_t * | sip_reason_dup (su_home_t *home, sip_reason_t const *hdr)) |
Duplicate (deep copy) sip_reason_t . | |
sip_reason_t * | sip_reason_copy (su_home_t *home, sip_reason_t const *hdr)) |
Copy a sip_reason_t header structure. | |
sip_reason_t * | sip_reason_make (su_home_t *home, char const *s)) |
Make a header structure sip_reason_t. | |
sip_reason_t * | sip_reason_format (su_home_t *home, char const *fmt,...))) |
Make a Reason header from formatting result. | |
Variables | |
tag_typedef_t | siptag_reason |
Tag for Reason header object. | |
tag_typedef_t | siptag_reason_str |
Tag for string with Reason header value. | |
msg_hclass_t | sip_reason_class [] |
Header class for SIP Reason header. |
#define SIP_REASON_INIT | ( | ) |
Initializer for structure sip_reason_t.
A static sip_reason_t structure must be initialized. The SIP_REASON_INIT() macro provides initialization value. For instance,
#define SIPTAG_REASON | ( | x | ) |
Tag list item for pointer to a Reason header structure.
The SIPTAG_REASON() macro is used to include a tag item with a pointer to a sip_reason_t object in a tag list.
x | pointer to a sip_reason_t header structure, or NULL. |
#define SIPTAG_REASON_STR | ( | s | ) |
Tag list item for string with Reason header value.
The SIPTAG_REASON_STR() macro is used to include a tag item with a string containing value of a sip_reason_t header in a tag list.
s | pointer to a string containing sip_reason_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_REASON_STR_REF().
sip_reason_hash |
@
Hash of Reason header.
int sip_is_reason | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_reason_t.
The function sip_is_reason() returns true (nonzero) if the header class is an instance of Reason header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_reason_t * sip_reason_copy | ( | su_home_t * | home, | |
sip_reason_t const * | hdr | |||
) | [inline] |
Copy a sip_reason_t header structure.
The function sip_reason_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 |
reason = sip_reason_copy(home, sip->sip_reason);
sip_reason_t * sip_reason_dup | ( | su_home_t * | home, | |
sip_reason_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_reason_t
.
The function sip_reason_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 |
reason = sip_reason_dup(home, sip->sip_reason);
sip_reason_t * sip_reason_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Reason header from formatting result.
The function sip_reason_format() makes a new Reason 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_reason_t* sip_reason_init | ( | sip_reason_t | x[1] | ) | [inline] |
Initialize a structure sip_reason_t.
An sip_reason_t structure can be initialized with the sip_reason_init() function/macro. For instance,
sip_reason_t * sip_reason_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_reason_t.
The function sip_reason_make() makes a new sip_reason_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 Reason header.
The header class sip_reason_class defines how a SIP Reason header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_reason_t header structure.