http  1.13.17
Macros | Enumerations | Functions | Variables
Http_origin

Macros

#define HTTP_ORIGIN_INIT()
 Initializer for structure http_origin_t. More...
 
#define HTTPTAG_ORIGIN(x)
 Tag list item for pointer to a Origin header object. More...
 
#define HTTPTAG_ORIGIN_STR(s)
 Tag list item for string with Origin header value. More...
 

Enumerations

enum  { http_origin_hash }
 

Functions

http_origin_t * http_origin_init (http_origin_t x[1])
 Initialize a structure http_origin_t. More...
 
int http_is_origin (http_header_t const *header)
 Test if header object is instance of http_origin_t. More...
 
http_origin_t * http_origin_dup (su_home_t *home, http_origin_t const *hdr))
 Duplicate (deep copy) http_origin_t. More...
 
http_origin_t * http_origin_copy (su_home_t *home, http_origin_t const *hdr))
 Copy a http_origin_t header structure. More...
 
http_origin_t * http_origin_make (su_home_t *home, char const *s))
 Make a header structure http_origin_t. More...
 
http_origin_t * http_origin_format (su_home_t *home, char const *fmt,...)))
 Make a Origin header from formatting result. More...
 

Variables

msg_hclass_t http_origin_class []
 Header class for HTTP Origin header. More...
 
msg_parse_f http_origin_d
 Decode (parse) a Origin header.
 
msg_print_f http_origin_e
 Encode (print) a Origin header.
 

Detailed Description

Macro Definition Documentation

◆ HTTP_ORIGIN_INIT

#define HTTP_ORIGIN_INIT ( )

Initializer for structure http_origin_t.

A static http_origin_t structure must be initialized with the HTTP_ORIGIN_INIT() macro. For instance,

http_origin_t http_origin = HTTP_ORIGIN_INIT;
#define HTTP_ORIGIN_INIT()
Initializer for structure http_origin_t.
Definition: http_protos.h:11842

◆ HTTPTAG_ORIGIN

#define HTTPTAG_ORIGIN (   x)

Tag list item for pointer to a Origin header object.

The HTTPTAG_ORIGIN() macro is used to include a tag item with a pointer to a http_origin_t object in a tag list.

Parameters
xpointer to a http_origin_t header structure, or NULL.

◆ HTTPTAG_ORIGIN_STR

#define HTTPTAG_ORIGIN_STR (   s)

Tag list item for string with Origin header value.

The HTTPTAG_ORIGIN_STR() macro is used to include a tag item with a string containing value of a http_origin_t header in a tag list.

Parameters
spointer to a string containing http_origin_t value, or NULL.

The HTTPTAG_ORIGIN_STR string can be converted to a http_origin_t header structure by giving the string s has second argument to function http_origin_make().

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
http_origin_hash 

Hash of Origin header.

Function Documentation

◆ http_is_origin()

int http_is_origin ( http_header_t const *  header)
inline

Test if header object is instance of http_origin_t.

The function http_is_origin() returns true (nonzero) if the header class is an instance of Origin header object and false (zero) otherwise.

Parameters
headerpointer to the header structure to be tested
Returns
The function http_is_xorigin() returns true (nonzero) if the header object is an instance of header origin and false (zero) otherwise.

◆ http_origin_copy()

http_origin_t * http_origin_copy ( su_home_t home,
http_origin_t const *  hdr 
)
inline

Copy a http_origin_t header structure.

The function http_origin_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.

Parameters
homememory home used to allocate new structure
hdrpointer 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
origin = http_origin_copy(home, http->http_origin);
http_origin_t * http_origin_copy(su_home_t *home, http_origin_t const *hdr))
Copy a http_origin_t header structure.
Definition: http_protos.h:12036
Returns
The function http_origin_copy() returns a pointer to newly copied header structure, or NULL upon an error.

◆ http_origin_dup()

http_origin_t * http_origin_dup ( su_home_t home,
http_origin_t const *  hdr 
)
inline

Duplicate (deep copy) http_origin_t.

The function http_origin_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.

Parameters
homememory home used to allocate new structure
hdrheader 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
origin = http_origin_dup(home, http->http_origin);
http_origin_t * http_origin_dup(su_home_t *home, http_origin_t const *hdr))
Duplicate (deep copy) http_origin_t.
Definition: http_protos.h:12029
Returns
The function http_origin_dup() returns a pointer to the newly duplicated http_origin_t header structure, or NULL upon an error.

◆ http_origin_format()

http_origin_t * http_origin_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a Origin header from formatting result.

The function http_origin_format() makes a new Origin 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.

Parameters
homememory home used to allocate new header structure.
fmtstring used as a printf()-style format
...argument list for format
Note
This function is usually implemented as a macro calling msg_header_format().
Returns
The function http_origin_format() returns a pointer to newly makes header structure, or NULL upon an error.

◆ http_origin_init()

http_origin_t* http_origin_init ( http_origin_t  x[1])
inline

Initialize a structure http_origin_t.

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

http_origin_t http_origin;
http_origin_init(&http_origin);
http_origin_t * http_origin_init(http_origin_t x[1])
Initialize a structure http_origin_t.
Definition: http_protos.h:11858

◆ http_origin_make()

http_origin_t * http_origin_make ( su_home_t home,
char const *  s 
)
inline

Make a header structure http_origin_t.

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

Parameters
homememory home used to allocate new header structure.
sstring to be decoded as value of the new header structure
Note
This function is usually implemented as a macro calling http_header_make().
Returns
The function http_origin_make() returns a pointer to newly maked http_origin_t header structure, or NULL upon an error.

Variable Documentation

◆ http_origin_class

msg_hclass_t http_origin_class[]
extern

Header class for HTTP Origin header.

The header class http_origin_class defines how a HTTP Origin header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_origin_t header structure.


Sofia-SIP 1.13.17 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.