Collaboration diagram for User-Agent Header:
![]() |
Its syntax is defined in [H14.43, S10.45] as follows:
User-Agent = "User-Agent" HCOLON server-val *(LWS server-val) server-val = product / comment product = token [SLASH product-version] product-version = token
Defines | |
#define | sip_user_agent(sip) |
Access a sip_user_agent_t from sip_t. | |
#define | SIP_USER_AGENT_INIT() |
Initializer for structure sip_user_agent_t. | |
#define | SIPTAG_USER_AGENT(x) |
Tag list item for pointer to a User-Agent header structure. | |
#define | SIPTAG_USER_AGENT_REF(x) |
Tag list item for reference to a a User-Agent header pointer. | |
#define | SIPTAG_USER_AGENT_STR(s) |
Tag list item for string with User-Agent header value. | |
#define | SIPTAG_USER_AGENT_STR_REF(x) |
Tag list item for reference to a a User-Agent header string. | |
Enumerator | |
sip_user_agent_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_user_agent_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a User-Agent header. | |
SOFIAPUBFUN int | sip_user_agent_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a User-Agent header. | |
sip_user_agent_t * | sip_user_agent_init (sip_user_agent_t x[1]) |
Initialize a structure sip_user_agent_t. | |
int | sip_is_user_agent (sip_header_t const *header) |
Test if header object is instance of sip_user_agent_t. | |
sip_user_agent_t * | sip_user_agent_dup (su_home_t *home, sip_user_agent_t const *hdr)) |
Duplicate (deep copy) sip_user_agent_t . | |
sip_user_agent_t * | sip_user_agent_copy (su_home_t *home, sip_user_agent_t const *hdr)) |
Copy a sip_user_agent_t header structure. | |
sip_user_agent_t * | sip_user_agent_make (su_home_t *home, char const *s)) |
Make a header structure sip_user_agent_t. | |
sip_user_agent_t * | sip_user_agent_format (su_home_t *home, char const *fmt,...))) |
Make a User-Agent header from formatting result. | |
Variables | |
tag_typedef_t | siptag_user_agent |
Tag for User-Agent header object. | |
tag_typedef_t | siptag_user_agent_str |
Tag for string with User-Agent header value. | |
msg_hclass_t | sip_user_agent_class [] |
Header class for SIP User-Agent header. |
#define SIP_USER_AGENT_INIT | ( | ) |
Initializer for structure sip_user_agent_t.
A static sip_user_agent_t structure must be initialized. The SIP_USER_AGENT_INIT() macro provides initialization value. For instance,
#define SIPTAG_USER_AGENT | ( | x | ) |
Tag list item for pointer to a User-Agent header structure.
The SIPTAG_USER_AGENT() macro is used to include a tag item with a pointer to a sip_user_agent_t object in a tag list.
x | pointer to a sip_user_agent_t header structure, or NULL. |
#define SIPTAG_USER_AGENT_STR | ( | s | ) |
Tag list item for string with User-Agent header value.
The SIPTAG_USER_AGENT_STR() macro is used to include a tag item with a string containing value of a sip_user_agent_t header in a tag list.
s | pointer to a string containing sip_user_agent_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_USER_AGENT_STR_REF().
sip_user_agent_hash |
@
Hash of User-Agent header.
int sip_is_user_agent | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_user_agent_t.
The function sip_is_user_agent() returns true (nonzero) if the header class is an instance of User-Agent header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_user_agent_t * sip_user_agent_copy | ( | su_home_t * | home, | |
sip_user_agent_t const * | hdr | |||
) | [inline] |
Copy a sip_user_agent_t header structure.
The function sip_user_agent_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 |
user_agent = sip_user_agent_copy(home, sip->sip_user_agent);
sip_user_agent_t * sip_user_agent_dup | ( | su_home_t * | home, | |
sip_user_agent_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_user_agent_t
.
The function sip_user_agent_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 |
user_agent = sip_user_agent_dup(home, sip->sip_user_agent);
sip_user_agent_t * sip_user_agent_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a User-Agent header from formatting result.
The function sip_user_agent_format() makes a new User-Agent 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_user_agent_t* sip_user_agent_init | ( | sip_user_agent_t | x[1] | ) | [inline] |
Initialize a structure sip_user_agent_t.
An sip_user_agent_t structure can be initialized with the sip_user_agent_init() function/macro. For instance,
sip_user_agent_t * sip_user_agent_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_user_agent_t.
The function sip_user_agent_make() makes a new sip_user_agent_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 User-Agent header.
The header class sip_user_agent_class defines how a SIP User-Agent header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_user_agent_t header structure.