Collaboration diagram for Error-Info Header:
![]() |
Its syntax is defined in [S10.23] as follows:
Error-Info = "Error-Info" HCOLON error-uri *(COMMA error-uri)
error-uri = LAQUOT absoluteURI RAQUOT *( SEMI generic-param )
Data Structures | |
struct | sip_error_info_s |
Structure for Error-Info header. More... | |
Defines | |
#define | sip_error_info(sip) |
Access a sip_error_info_t from sip_t. | |
#define | SIP_ERROR_INFO_INIT() |
Initializer for structure sip_error_info_t. | |
#define | SIPTAG_ERROR_INFO(x) |
Tag list item for pointer to a Error-Info header structure. | |
#define | SIPTAG_ERROR_INFO_REF(x) |
Tag list item for reference to a a Error-Info header pointer. | |
#define | SIPTAG_ERROR_INFO_STR(s) |
Tag list item for string with Error-Info header value. | |
#define | SIPTAG_ERROR_INFO_STR_REF(x) |
Tag list item for reference to a a Error-Info header string. | |
Typedefs | |
typedef sip_error_info_s | sip_error_info_t |
The structure sip_error_info_t contains representation of an Error-Info header. | |
Enumerator | |
sip_error_info_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_error_info_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Error-Info header. | |
SOFIAPUBFUN int | sip_error_info_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Error-Info header. | |
sip_error_info_t * | sip_error_info_init (sip_error_info_t x[1]) |
Initialize a structure sip_error_info_t. | |
int | sip_is_error_info (sip_header_t const *header) |
Test if header object is instance of sip_error_info_t. | |
sip_error_info_t * | sip_error_info_dup (su_home_t *home, sip_error_info_t const *hdr)) |
Duplicate (deep copy) sip_error_info_t . | |
sip_error_info_t * | sip_error_info_copy (su_home_t *home, sip_error_info_t const *hdr)) |
Copy a sip_error_info_t header structure. | |
sip_error_info_t * | sip_error_info_make (su_home_t *home, char const *s)) |
Make a header structure sip_error_info_t. | |
sip_error_info_t * | sip_error_info_format (su_home_t *home, char const *fmt,...))) |
Make a Error-Info header from formatting result. | |
Variables | |
tag_typedef_t | siptag_error_info |
Tag for Error-Info header object. | |
tag_typedef_t | siptag_error_info_str |
Tag for string with Error-Info header value. | |
msg_hclass_t | sip_error_info_class [] |
Header class for SIP Error-Info header. |
#define SIP_ERROR_INFO_INIT | ( | ) |
Initializer for structure sip_error_info_t.
A static sip_error_info_t structure must be initialized. The SIP_ERROR_INFO_INIT() macro provides initialization value. For instance,
#define SIPTAG_ERROR_INFO | ( | x | ) |
Tag list item for pointer to a Error-Info header structure.
The SIPTAG_ERROR_INFO() macro is used to include a tag item with a pointer to a sip_error_info_t object in a tag list.
x | pointer to a sip_error_info_t header structure, or NULL. |
#define SIPTAG_ERROR_INFO_STR | ( | s | ) |
Tag list item for string with Error-Info header value.
The SIPTAG_ERROR_INFO_STR() macro is used to include a tag item with a string containing value of a sip_error_info_t header in a tag list.
s | pointer to a string containing sip_error_info_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_ERROR_INFO_STR_REF().
struct sip_error_info_s sip_error_info_t |
The structure sip_error_info_t contains representation of an Error-Info header.
The sip_error_info_t is defined as follows:
struct sip_error_info_s { sip_common_t ei_common[1]; // Common fragment info sip_error_info_t *ei_next; // Link to next Error-Info url_t ei_url[1]; // URI to error info msg_param_t const *ei_params; // List of parameters };
sip_error_info_hash |
@
Hash of Error-Info header.
sip_error_info_t * sip_error_info_copy | ( | su_home_t * | home, | |
sip_error_info_t const * | hdr | |||
) | [inline] |
Copy a sip_error_info_t header structure.
The function sip_error_info_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 |
error_info = sip_error_info_copy(home, sip->sip_error_info);
sip_error_info_t * sip_error_info_dup | ( | su_home_t * | home, | |
sip_error_info_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_error_info_t
.
The function sip_error_info_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 |
error_info = sip_error_info_dup(home, sip->sip_error_info);
sip_error_info_t * sip_error_info_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Error-Info header from formatting result.
The function sip_error_info_format() makes a new Error-Info 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_error_info_t* sip_error_info_init | ( | sip_error_info_t | x[1] | ) | [inline] |
Initialize a structure sip_error_info_t.
An sip_error_info_t structure can be initialized with the sip_error_info_init() function/macro. For instance,
sip_error_info_t * sip_error_info_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_error_info_t.
The function sip_error_info_make() makes a new sip_error_info_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_error_info | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_error_info_t.
The function sip_is_error_info() returns true (nonzero) if the header class is an instance of Error-Info header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Error-Info header.
The header class sip_error_info_class defines how a SIP Error-Info header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_error_info_t header structure.