Collaboration diagram for Warning Header:
![]() |
Its syntax is defined in [S20.43] as follows:
Warning = "Warning" HCOLON warning-value *(COMMA warning-value) warning-value = warn-code SP warn-agent SP warn-text warn-code = 3DIGIT warn-agent = hostport / pseudonym ; the name or pseudonym of the server adding ; the Warning header, for use in debugging warn-text = quoted-string pseudonym = token
Defines | |
#define | sip_warning(sip) |
Access a sip_warning_t from sip_t. | |
#define | SIP_WARNING_INIT() |
Initializer for structure sip_warning_t. | |
#define | SIPTAG_WARNING(x) |
Tag list item for pointer to a Warning header structure. | |
#define | SIPTAG_WARNING_REF(x) |
Tag list item for reference to a a Warning header pointer. | |
#define | SIPTAG_WARNING_STR(s) |
Tag list item for string with Warning header value. | |
#define | SIPTAG_WARNING_STR_REF(x) |
Tag list item for reference to a a Warning header string. | |
Typedefs | |
typedef msg_warning_t | sip_warning_t |
The structure sip_warning_t contains representation of an Warning header. | |
Enumerator | |
sip_warning_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_warning_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Warning header. | |
SOFIAPUBFUN int | sip_warning_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Warning header. | |
sip_warning_t * | sip_warning_init (sip_warning_t x[1]) |
Initialize a structure sip_warning_t. | |
int | sip_is_warning (sip_header_t const *header) |
Test if header object is instance of sip_warning_t. | |
sip_warning_t * | sip_warning_dup (su_home_t *home, sip_warning_t const *hdr)) |
Duplicate (deep copy) sip_warning_t . | |
sip_warning_t * | sip_warning_copy (su_home_t *home, sip_warning_t const *hdr)) |
Copy a sip_warning_t header structure. | |
sip_warning_t * | sip_warning_make (su_home_t *home, char const *s)) |
Make a header structure sip_warning_t. | |
sip_warning_t * | sip_warning_format (su_home_t *home, char const *fmt,...))) |
Make a Warning header from formatting result. | |
Variables | |
tag_typedef_t | siptag_warning |
Tag for Warning header object. | |
tag_typedef_t | siptag_warning_str |
Tag for string with Warning header value. | |
msg_hclass_t | sip_warning_class [] |
Header class for SIP Warning header. |
#define SIP_WARNING_INIT | ( | ) |
Initializer for structure sip_warning_t.
A static sip_warning_t structure must be initialized. The SIP_WARNING_INIT() macro provides initialization value. For instance,
#define SIPTAG_WARNING | ( | x | ) |
Tag list item for pointer to a Warning header structure.
The SIPTAG_WARNING() macro is used to include a tag item with a pointer to a sip_warning_t object in a tag list.
x | pointer to a sip_warning_t header structure, or NULL. |
#define SIPTAG_WARNING_STR | ( | s | ) |
Tag list item for string with Warning header value.
The SIPTAG_WARNING_STR() macro is used to include a tag item with a string containing value of a sip_warning_t header in a tag list.
s | pointer to a string containing sip_warning_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_WARNING_STR_REF().
struct msg_warning_s sip_warning_t |
The structure sip_warning_t contains representation of an Warning header.
The sip_warning_t is defined as follows:
typedef struct msg_warning_s { msg_common_t w_common[1]; // Common fragment info msg_warning_t *w_next; // Link to next Warning header unsigned w_code; // Warning code char const *w_host; // Hostname or pseudonym char const *w_port; // Port number char const *w_text; // Warning text } sip_warning_t;
sip_warning_hash |
@
Hash of Warning header.
int sip_is_warning | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_warning_t.
The function sip_is_warning() returns true (nonzero) if the header class is an instance of Warning header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_warning_t * sip_warning_copy | ( | su_home_t * | home, | |
sip_warning_t const * | hdr | |||
) | [inline] |
Copy a sip_warning_t header structure.
The function sip_warning_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 |
warning = sip_warning_copy(home, sip->sip_warning);
sip_warning_t * sip_warning_dup | ( | su_home_t * | home, | |
sip_warning_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_warning_t
.
The function sip_warning_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 |
warning = sip_warning_dup(home, sip->sip_warning);
sip_warning_t * sip_warning_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Warning header from formatting result.
The function sip_warning_format() makes a new Warning 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_warning_t* sip_warning_init | ( | sip_warning_t | x[1] | ) | [inline] |
Initialize a structure sip_warning_t.
An sip_warning_t structure can be initialized with the sip_warning_init() function/macro. For instance,
sip_warning_t * sip_warning_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_warning_t.
The function sip_warning_make() makes a new sip_warning_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 Warning header.
The header class sip_warning_class defines how a SIP Warning header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_warning_t header structure.