Accept-Language Header [MIME Headers]

The Accept-Language header allows the client to indicate to the server in which language it would prefer to receive reason phrases, session descriptions or status responses carried as message bodies. More...

Defines
#define	MSG_ACCEPT_LANGUAGE_INIT()
	Initializer for an msg_accept_language_t structure.
Typedefs
typedef msg_accept_any_t	msg_accept_language_t
	The structure msg_accept_language_t contains representation of Accept-Language header.
Enumerations
enum	{ msg_accept_language_hash }
Functions
msg_accept_language_t *	msg_accept_language_init (msg_accept_language_t x[1])
	Initialize an msg_accept_language_t structure.
int	msg_is_accept_language (msg_header_t const *header)
	Test if header object is an instance of msg_accept_language_t.
msg_accept_language_t *	msg_accept_language_dup (su_home_t *home, msg_accept_language_t const *header)
	Duplicate (deep copy) msg_accept_language_t.
msg_accept_language_t *	msg_accept_language_copy (su_home_t *home, msg_accept_language_t const *header)
	Copy an msg_accept_language_t header structure.
msg_accept_language_t *	msg_accept_language_make (su_home_t *home, char const *s)
	Make a header structure msg_accept_language_t.
msg_accept_language_t *	msg_accept_language_format (su_home_t *home, char const *fmt,...)))
	Make a Accept-Language header from formatting result.
Variables
msg_parse_f	msg_accept_language_d
	Parse a Accept-Language header.
msg_print_f	msg_accept_language_e
	Print a Accept-Language header.
msg_hclass_t	msg_accept_language_class []
	Header class for Accept-Language header.

---

Detailed Description

The Accept-Language header allows the client to indicate to the server in which language it would prefer to receive reason phrases, session descriptions or status responses carried as message bodies.

Its syntax is defined in [H14.4, S20.3] as follows:

    Accept-Language = "Accept-Language" ":"
                      1#( language-range [ ";" "q" "=" qvalue ] )

    language-range  = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )

---

Define Documentation

#define MSG_ACCEPT_LANGUAGE_INIT

(

)

Initializer for an msg_accept_language_t structure.

A static msg_accept_language_t structure must be initialized with the MSG_ACCEPT_LANGUAGE_INIT() macro. For instance,

  msg_accept_language_t msg_accept_language = MSG_ACCEPT_LANGUAGE_INIT;

---

Typedef Documentation

typedef struct msg_accept_language_s msg_accept_language_t

The structure msg_accept_language_t contains representation of Accept-Language header.

The msg_accept_language_t is defined as follows:

 typedef struct {
   msg_common_t        aa_common[1]; // Common fragment info
   msg_accept_any_t   *aa_next;      // Pointer to next Accept-Encoding
   char const         *aa_value;     // Language-range
   msg_param_t const  *aa_params;    // Parameter list
   char const         *aa_q;           // Q-value
 } msg_accept_language_t;

---

Enumeration Type Documentation

anonymous enum

Enumerator:

msg_accept_language_hash

Hash of Accept-Language header.

---

Function Documentation

msg_accept_language_t * msg_accept_language_copy	(	su_home_t *	home,
		msg_accept_language_t const *	header
	)			[inline]

Copy an msg_accept_language_t header structure.

The function msg_accept_language_copy() copies a header structure header. If the header structure header contains a reference (header->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 header.

Parameters:

	home	memory home used to allocate new structure
	header	pointer to the header structure to be duplicated

When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old header, including the encoding of the old header, if present.

Example

   accept_language = msg_accept_language_copy(home, msg->msg_accept_language);

Returns:

The function msg_accept_language_copy() returns a pointer to newly copied header structure, or NULL upon an error.

msg_accept_language_t * msg_accept_language_dup	(	su_home_t *	home,
		msg_accept_language_t const *	header
	)			[inline]

Duplicate (deep copy) msg_accept_language_t.

The function msg_accept_language_dup() duplicates a header structure header. If the header structure header contains a reference (header->x_next) to a list of headers, all the headers in the list are duplicated, too.

Parameters:

	home	memory home used to allocate new structure
	header	header structure to be duplicated

When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.

Example

   accept_language = msg_accept_language_dup(home, msg->msg_accept_language);

Returns:

The function msg_accept_language_dup() returns a pointer to the newly duplicated msg_accept_language_t header structure, or NULL upon an error.

msg_accept_language_t * msg_accept_language_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Accept-Language header from formatting result.

The function msg_accept_language_format() makes a new Accept-Language header object using snprintf-formatted 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.

Parameters:

	home	memory home used to allocate new header structure.
	fmt	string used as a printf()-style format
	...	argument list for format

Note:

This function may be implemented as a macro calling msg_header_format().

Returns:

The function msg_accept_language_format() returns a pointer to newly makes header structure, or NULL upon an error.

msg_accept_language_t* msg_accept_language_init

(

msg_accept_language_t

x[1]

)

[inline]

Initialize an msg_accept_language_t structure.

An msg_accept_language_t structure can be initialized with the msg_accept_language_init() function/macro. For instance,

  msg_accept_language_t msg_accept_language;

  msg_accept_language_init(&msg_accept_language);

Parameters:

x

pointer to msg_accept_language_t structure

msg_accept_language_t* msg_accept_language_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure msg_accept_language_t.

The function msg_accept_language_make() makes a new msg_accept_language_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters:

	home	memory home used to allocate new header structure.
	s	string to be decoded as value of the new header structure

Note:

This function may be implemented as a macro calling msg_header_make().

Returns:

The function msg_accept_language_make() returns a pointer to newly maked msg_accept_language_t header structure, or NULL upon an error.

int msg_is_accept_language

(

msg_header_t const *

header

)

[inline]

Test if header object is an instance of msg_accept_language_t.

The function msg_is_accept_language() returns true (nonzero) if the header class is an instance of Accept-Language header object and false (zero) otherwise.

Parameters:

header

pointer to the header structure to be tested

Returns:

The function msg_is_accept_language() returns true (nonzero) if the header object is an instance of header Accept-Language header and false (zero) otherwise.

---

Variable Documentation

msg_hclass_t msg_accept_language_class[]

Header class for Accept-Language header.

The header class msg_accept_language_class defines how a Accept-Language header header is parsed and printed. It also contains methods used by message parser and other functions to manipulate the msg_accept_language_t header structure.