Collaboration diagram for Server Header:
![]() |
Its syntax is defined in [H14.38, S10.39] as follows:
Server = "Server" HCOLON server-val *(LWS server-val) server-val = product / comment product = token [SLASH product-version] product-version = token
Defines | |
#define | sip_server(sip) |
Access a sip_server_t from sip_t. | |
#define | SIP_SERVER_INIT() |
Initializer for structure sip_server_t. | |
#define | SIPTAG_SERVER(x) |
Tag list item for pointer to a Server header structure. | |
#define | SIPTAG_SERVER_REF(x) |
Tag list item for reference to a a Server header pointer. | |
#define | SIPTAG_SERVER_STR(s) |
Tag list item for string with Server header value. | |
#define | SIPTAG_SERVER_STR_REF(x) |
Tag list item for reference to a a Server header string. | |
Enumerator | |
sip_server_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_server_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Server header. | |
SOFIAPUBFUN int | sip_server_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Server header. | |
sip_server_t * | sip_server_init (sip_server_t x[1]) |
Initialize a structure sip_server_t. | |
int | sip_is_server (sip_header_t const *header) |
Test if header object is instance of sip_server_t. | |
sip_server_t * | sip_server_dup (su_home_t *home, sip_server_t const *hdr)) |
Duplicate (deep copy) sip_server_t . | |
sip_server_t * | sip_server_copy (su_home_t *home, sip_server_t const *hdr)) |
Copy a sip_server_t header structure. | |
sip_server_t * | sip_server_make (su_home_t *home, char const *s)) |
Make a header structure sip_server_t. | |
sip_server_t * | sip_server_format (su_home_t *home, char const *fmt,...))) |
Make a Server header from formatting result. | |
Variables | |
tag_typedef_t | siptag_server |
Tag for Server header object. | |
tag_typedef_t | siptag_server_str |
Tag for string with Server header value. | |
msg_hclass_t | sip_server_class [] |
Header class for SIP Server header. |
#define SIP_SERVER_INIT | ( | ) |
Initializer for structure sip_server_t.
A static sip_server_t structure must be initialized. The SIP_SERVER_INIT() macro provides initialization value. For instance,
#define SIPTAG_SERVER | ( | x | ) |
Tag list item for pointer to a Server header structure.
The SIPTAG_SERVER() macro is used to include a tag item with a pointer to a sip_server_t object in a tag list.
x | pointer to a sip_server_t header structure, or NULL. |
#define SIPTAG_SERVER_STR | ( | s | ) |
Tag list item for string with Server header value.
The SIPTAG_SERVER_STR() macro is used to include a tag item with a string containing value of a sip_server_t header in a tag list.
s | pointer to a string containing sip_server_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SERVER_STR_REF().
sip_server_hash |
@
Hash of Server header.
int sip_is_server | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_server_t.
The function sip_is_server() returns true (nonzero) if the header class is an instance of Server header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_server_t * sip_server_copy | ( | su_home_t * | home, | |
sip_server_t const * | hdr | |||
) | [inline] |
Copy a sip_server_t header structure.
The function sip_server_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 |
server = sip_server_copy(home, sip->sip_server);
sip_server_t * sip_server_dup | ( | su_home_t * | home, | |
sip_server_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_server_t
.
The function sip_server_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 |
server = sip_server_dup(home, sip->sip_server);
sip_server_t * sip_server_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Server header from formatting result.
The function sip_server_format() makes a new Server 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_server_t* sip_server_init | ( | sip_server_t | x[1] | ) | [inline] |
Initialize a structure sip_server_t.
An sip_server_t structure can be initialized with the sip_server_init() function/macro. For instance,
sip_server_t * sip_server_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_server_t.
The function sip_server_make() makes a new sip_server_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 Server header.
The header class sip_server_class defines how a SIP Server header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_server_t header structure.