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

Macros

#define HTTP_ETAG_INIT()
 Initializer for structure http_etag_t.
 
#define HTTPTAG_ETAG(x)
 Tag list item for pointer to a ETag header object.
 
#define HTTPTAG_ETAG_STR(s)
 Tag list item for string with ETag header value.
 

Enumerations

enum  { http_etag_hash }
 

Functions

http_etag_t * http_etag_init (http_etag_t x[1])
 Initialize a structure http_etag_t.
 
int http_is_etag (http_header_t const *header)
 Test if header object is instance of http_etag_t.
 
http_etag_t * http_etag_dup (su_home_t *home, http_etag_t const *hdr))
 Duplicate (deep copy) http_etag_t.
 
http_etag_t * http_etag_copy (su_home_t *home, http_etag_t const *hdr))
 Copy a http_etag_t header structure.
 
http_etag_t * http_etag_make (su_home_t *home, char const *s))
 Make a header structure http_etag_t.
 
http_etag_t * http_etag_format (su_home_t *home, char const *fmt,...)))
 Make a ETag header from formatting result.
 

Variables

msg_hclass_t http_etag_class []
 Header class for HTTP ETag header.
 
msg_parse_f http_etag_d
 Decode (parse) a ETag header.
 
msg_print_f http_etag_e
 Encode (print) a ETag header.
 

Detailed Description

Macro Definition Documentation

◆ HTTP_ETAG_INIT

#define HTTP_ETAG_INIT ( )

Initializer for structure http_etag_t.

A static http_etag_t structure must be initialized with the HTTP_ETAG_INIT() macro. For instance,

http_etag_t http_etag = HTTP_ETAG_INIT;
#define HTTP_ETAG_INIT()
Initializer for structure http_etag_t.
Definition http_protos.h:3592

◆ HTTPTAG_ETAG

#define HTTPTAG_ETAG (   x)

Tag list item for pointer to a ETag header object.

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

Parameters
xpointer to a http_etag_t header structure, or NULL.

◆ HTTPTAG_ETAG_STR

#define HTTPTAG_ETAG_STR (   s)

Tag list item for string with ETag header value.

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

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

The HTTPTAG_ETAG_STR string can be converted to a http_etag_t header structure by giving the string s has second argument to function http_etag_make().

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
http_etag_hash 

Hash of ETag header.

Function Documentation

◆ http_etag_copy()

http_etag_t * http_etag_copy ( su_home_t home,
http_etag_t const *  hdr 
)
inline

Copy a http_etag_t header structure.

The function http_etag_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
etag = http_etag_copy(home, http->http_etag);
http_etag_t * http_etag_copy(su_home_t *home, http_etag_t const *hdr))
Copy a http_etag_t header structure.
Definition http_protos.h:3786
Returns
The function http_etag_copy() returns a pointer to newly copied header structure, or NULL upon an error.

◆ http_etag_dup()

http_etag_t * http_etag_dup ( su_home_t home,
http_etag_t const *  hdr 
)
inline

Duplicate (deep copy) http_etag_t.

The function http_etag_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
etag = http_etag_dup(home, http->http_etag);
http_etag_t * http_etag_dup(su_home_t *home, http_etag_t const *hdr))
Duplicate (deep copy) http_etag_t.
Definition http_protos.h:3779
Returns
The function http_etag_dup() returns a pointer to the newly duplicated http_etag_t header structure, or NULL upon an error.

◆ http_etag_format()

http_etag_t * http_etag_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a ETag header from formatting result.

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

◆ http_etag_init()

http_etag_t * http_etag_init ( http_etag_t  x[1])
inline

Initialize a structure http_etag_t.

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

http_etag_t http_etag;
http_etag_init(&http_etag);
http_etag_t * http_etag_init(http_etag_t x[1])
Initialize a structure http_etag_t.
Definition http_protos.h:3608

◆ http_etag_make()

http_etag_t * http_etag_make ( su_home_t home,
char const *  s 
)
inline

Make a header structure http_etag_t.

The function http_etag_make() makes a new http_etag_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_etag_make() returns a pointer to newly maked http_etag_t header structure, or NULL upon an error.

◆ http_is_etag()

int http_is_etag ( http_header_t const *  header)
inline

Test if header object is instance of http_etag_t.

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

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

Variable Documentation

◆ http_etag_class

msg_hclass_t http_etag_class[]
extern

Header class for HTTP ETag header.

The header class http_etag_class defines how a HTTP ETag header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_etag_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.