http 1.12.11devel
Loading...
Searching...
No Matches
Macros | Enumerations | Functions | Variables
Http_from

Macros

#define HTTP_FROM_INIT()
 Initializer for structure http_from_t.
 
#define HTTPTAG_FROM(x)
 Tag list item for pointer to a From header object.
 
#define HTTPTAG_FROM_STR(s)
 Tag list item for string with From header value.
 

Enumerations

enum  { http_from_hash }
 

Functions

http_from_t * http_from_init (http_from_t x[1])
 Initialize a structure http_from_t.
 
int http_is_from (http_header_t const *header)
 Test if header object is instance of http_from_t.
 
http_from_t * http_from_dup (su_home_t *home, http_from_t const *hdr))
 Duplicate (deep copy) http_from_t.
 
http_from_t * http_from_copy (su_home_t *home, http_from_t const *hdr))
 Copy a http_from_t header structure.
 
http_from_t * http_from_make (su_home_t *home, char const *s))
 Make a header structure http_from_t.
 
http_from_t * http_from_format (su_home_t *home, char const *fmt,...)))
 Make a From header from formatting result.
 

Variables

msg_hclass_t http_from_class []
 Header class for HTTP From header.
 
msg_parse_f http_from_d
 Decode (parse) a From header.
 
msg_print_f http_from_e
 Encode (print) a From header.
 

Detailed Description

Macro Definition Documentation

◆ HTTP_FROM_INIT

#define HTTP_FROM_INIT ( )

Initializer for structure http_from_t.

A static http_from_t structure must be initialized with the HTTP_FROM_INIT() macro. For instance,

http_from_t http_from = HTTP_FROM_INIT;
#define HTTP_FROM_INIT()
Initializer for structure http_from_t.
Definition http_protos.h:4342

◆ HTTPTAG_FROM

#define HTTPTAG_FROM (   x)

Tag list item for pointer to a From header object.

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

Parameters
xpointer to a http_from_t header structure, or NULL.

◆ HTTPTAG_FROM_STR

#define HTTPTAG_FROM_STR (   s)

Tag list item for string with From header value.

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

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

The HTTPTAG_FROM_STR string can be converted to a http_from_t header structure by giving the string s has second argument to function http_from_make().

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
http_from_hash 

Hash of From header.

Function Documentation

◆ http_from_copy()

http_from_t * http_from_copy ( su_home_t home,
http_from_t const *  hdr 
)
inline

Copy a http_from_t header structure.

The function http_from_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
from = http_from_copy(home, http->http_from);
http_from_t * http_from_copy(su_home_t *home, http_from_t const *hdr))
Copy a http_from_t header structure.
Definition http_protos.h:4536
Returns
The function http_from_copy() returns a pointer to newly copied header structure, or NULL upon an error.

◆ http_from_dup()

http_from_t * http_from_dup ( su_home_t home,
http_from_t const *  hdr 
)
inline

Duplicate (deep copy) http_from_t.

The function http_from_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
from = http_from_dup(home, http->http_from);
http_from_t * http_from_dup(su_home_t *home, http_from_t const *hdr))
Duplicate (deep copy) http_from_t.
Definition http_protos.h:4529
Returns
The function http_from_dup() returns a pointer to the newly duplicated http_from_t header structure, or NULL upon an error.

◆ http_from_format()

http_from_t * http_from_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a From header from formatting result.

The function http_from_format() makes a new From 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_from_format() returns a pointer to newly makes header structure, or NULL upon an error.

◆ http_from_init()

http_from_t * http_from_init ( http_from_t  x[1])
inline

Initialize a structure http_from_t.

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

http_from_t http_from;
http_from_init(&http_from);
http_from_t * http_from_init(http_from_t x[1])
Initialize a structure http_from_t.
Definition http_protos.h:4358

◆ http_from_make()

http_from_t * http_from_make ( su_home_t home,
char const *  s 
)
inline

Make a header structure http_from_t.

The function http_from_make() makes a new http_from_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_from_make() returns a pointer to newly maked http_from_t header structure, or NULL upon an error.

◆ http_is_from()

int http_is_from ( http_header_t const *  header)
inline

Test if header object is instance of http_from_t.

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

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

Variable Documentation

◆ http_from_class

msg_hclass_t http_from_class[]
extern

Header class for HTTP From header.

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


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