Collaboration diagram for WWW-Authenticate Header:
![]() |
Its syntax is defined in [H14.47, S10.48] as follows:
WWW-Authenticate = "WWW-Authenticate" ":" 1#challenge challenge = auth-scheme 1*SP #auth-param
Defines | |
#define | sip_www_authenticate(sip) |
Access a sip_www_authenticate_t from sip_t. | |
#define | SIP_WWW_AUTHENTICATE_INIT() |
Initializer for structure sip_www_authenticate_t. | |
#define | SIPTAG_WWW_AUTHENTICATE(x) |
Tag list item for pointer to a WWW-Authenticate header structure. | |
#define | SIPTAG_WWW_AUTHENTICATE_REF(x) |
Tag list item for reference to a a WWW-Authenticate header pointer. | |
#define | SIPTAG_WWW_AUTHENTICATE_STR(s) |
Tag list item for string with WWW-Authenticate header value. | |
#define | SIPTAG_WWW_AUTHENTICATE_STR_REF(x) |
Tag list item for reference to a a WWW-Authenticate header string. | |
Enumerator | |
sip_www_authenticate_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_www_authenticate_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a WWW-Authenticate header. | |
SOFIAPUBFUN int | sip_www_authenticate_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a WWW-Authenticate header. | |
sip_www_authenticate_t * | sip_www_authenticate_init (sip_www_authenticate_t x[1]) |
Initialize a structure sip_www_authenticate_t. | |
int | sip_is_www_authenticate (sip_header_t const *header) |
Test if header object is instance of sip_www_authenticate_t. | |
sip_www_authenticate_t * | sip_www_authenticate_dup (su_home_t *home, sip_www_authenticate_t const *hdr)) |
Duplicate (deep copy) sip_www_authenticate_t . | |
sip_www_authenticate_t * | sip_www_authenticate_copy (su_home_t *home, sip_www_authenticate_t const *hdr)) |
Copy a sip_www_authenticate_t header structure. | |
sip_www_authenticate_t * | sip_www_authenticate_make (su_home_t *home, char const *s)) |
Make a header structure sip_www_authenticate_t. | |
sip_www_authenticate_t * | sip_www_authenticate_format (su_home_t *home, char const *fmt,...))) |
Make a WWW-Authenticate header from formatting result. | |
Variables | |
tag_typedef_t | siptag_www_authenticate |
Tag for WWW-Authenticate header object. | |
tag_typedef_t | siptag_www_authenticate_str |
Tag for string with WWW-Authenticate header value. | |
msg_hclass_t | sip_www_authenticate_class [] |
Header class for SIP WWW-Authenticate header. |
#define SIP_WWW_AUTHENTICATE_INIT | ( | ) |
Initializer for structure sip_www_authenticate_t.
A static sip_www_authenticate_t structure must be initialized. The SIP_WWW_AUTHENTICATE_INIT() macro provides initialization value. For instance,
sip_www_authenticate_t sip_www_authenticate = SIP_WWW_AUTHENTICATE_INIT;
#define SIPTAG_WWW_AUTHENTICATE | ( | x | ) |
Tag list item for pointer to a WWW-Authenticate header structure.
The SIPTAG_WWW_AUTHENTICATE() macro is used to include a tag item with a pointer to a sip_www_authenticate_t object in a tag list.
x | pointer to a sip_www_authenticate_t header structure, or NULL. |
#define SIPTAG_WWW_AUTHENTICATE_STR | ( | s | ) |
Tag list item for string with WWW-Authenticate header value.
The SIPTAG_WWW_AUTHENTICATE_STR() macro is used to include a tag item with a string containing value of a sip_www_authenticate_t header in a tag list.
s | pointer to a string containing sip_www_authenticate_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_WWW_AUTHENTICATE_STR_REF().
sip_www_authenticate_hash |
@
Hash of WWW-Authenticate header.
int sip_is_www_authenticate | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_www_authenticate_t.
The function sip_is_www_authenticate() returns true (nonzero) if the header class is an instance of WWW-Authenticate header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_www_authenticate_t * sip_www_authenticate_copy | ( | su_home_t * | home, | |
sip_www_authenticate_t const * | hdr | |||
) | [inline] |
Copy a sip_www_authenticate_t header structure.
The function sip_www_authenticate_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 |
www_authenticate = sip_www_authenticate_copy(home, sip->sip_www_authenticate);
sip_www_authenticate_t * sip_www_authenticate_dup | ( | su_home_t * | home, | |
sip_www_authenticate_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_www_authenticate_t
.
The function sip_www_authenticate_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 |
www_authenticate = sip_www_authenticate_dup(home, sip->sip_www_authenticate);
sip_www_authenticate_t * sip_www_authenticate_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a WWW-Authenticate header from formatting result.
The function sip_www_authenticate_format() makes a new WWW-Authenticate 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_www_authenticate_t* sip_www_authenticate_init | ( | sip_www_authenticate_t | x[1] | ) | [inline] |
Initialize a structure sip_www_authenticate_t.
An sip_www_authenticate_t structure can be initialized with the sip_www_authenticate_init() function/macro. For instance,
sip_www_authenticate_t sip_www_authenticate; sip_www_authenticate_init(&sip_www_authenticate);
sip_www_authenticate_t * sip_www_authenticate_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_www_authenticate_t.
The function sip_www_authenticate_make() makes a new sip_www_authenticate_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 WWW-Authenticate header.
The header class sip_www_authenticate_class defines how a SIP WWW-Authenticate header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_www_authenticate_t header structure.