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

Macros

#define HTTP_CONTENT_MD5_INIT()
 Initializer for structure http_content_md5_t.
 
#define HTTPTAG_CONTENT_MD5(x)
 Tag list item for pointer to a Content-MD5 header object.
 
#define HTTPTAG_CONTENT_MD5_STR(s)
 Tag list item for string with Content-MD5 header value.
 

Enumerations

enum  { http_content_md5_hash }
 

Functions

http_content_md5_t * http_content_md5_init (http_content_md5_t x[1])
 Initialize a structure http_content_md5_t.
 
int http_is_content_md5 (http_header_t const *header)
 Test if header object is instance of http_content_md5_t.
 
http_content_md5_t * http_content_md5_dup (su_home_t *home, http_content_md5_t const *hdr))
 Duplicate (deep copy) http_content_md5_t.
 
http_content_md5_t * http_content_md5_copy (su_home_t *home, http_content_md5_t const *hdr))
 Copy a http_content_md5_t header structure.
 
http_content_md5_t * http_content_md5_make (su_home_t *home, char const *s))
 Make a header structure http_content_md5_t.
 
http_content_md5_t * http_content_md5_format (su_home_t *home, char const *fmt,...)))
 Make a Content-MD5 header from formatting result.
 

Variables

msg_hclass_t http_content_md5_class []
 Header class for HTTP Content-MD5 header.
 
msg_parse_f http_content_md5_d
 Decode (parse) a Content-MD5 header.
 
msg_print_f http_content_md5_e
 Encode (print) a Content-MD5 header.
 

Detailed Description

Macro Definition Documentation

◆ HTTP_CONTENT_MD5_INIT

#define HTTP_CONTENT_MD5_INIT ( )

Initializer for structure http_content_md5_t.

A static http_content_md5_t structure must be initialized with the HTTP_CONTENT_MD5_INIT() macro. For instance,

http_content_md5_t http_content_md5 = HTTP_CONTENT_MD5_INIT;
#define HTTP_CONTENT_MD5_INIT()
Initializer for structure http_content_md5_t.
Definition http_protos.h:12842

◆ HTTPTAG_CONTENT_MD5

#define HTTPTAG_CONTENT_MD5 (   x)

Tag list item for pointer to a Content-MD5 header object.

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

Parameters
xpointer to a http_content_md5_t header structure, or NULL.

◆ HTTPTAG_CONTENT_MD5_STR

#define HTTPTAG_CONTENT_MD5_STR (   s)

Tag list item for string with Content-MD5 header value.

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

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

The HTTPTAG_CONTENT_MD5_STR string can be converted to a http_content_md5_t header structure by giving the string s has second argument to function http_content_md5_make().

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
http_content_md5_hash 

Hash of Content-MD5 header.

Function Documentation

◆ http_content_md5_copy()

http_content_md5_t * http_content_md5_copy ( su_home_t home,
http_content_md5_t const *  hdr 
)
inline

Copy a http_content_md5_t header structure.

The function http_content_md5_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
content_md5 = http_content_md5_copy(home, http->http_content_md5);
http_content_md5_t * http_content_md5_copy(su_home_t *home, http_content_md5_t const *hdr))
Copy a http_content_md5_t header structure.
Definition http_protos.h:13036
Returns
The function http_content_md5_copy() returns a pointer to newly copied header structure, or NULL upon an error.

◆ http_content_md5_dup()

http_content_md5_t * http_content_md5_dup ( su_home_t home,
http_content_md5_t const *  hdr 
)
inline

Duplicate (deep copy) http_content_md5_t.

The function http_content_md5_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
content_md5 = http_content_md5_dup(home, http->http_content_md5);
http_content_md5_t * http_content_md5_dup(su_home_t *home, http_content_md5_t const *hdr))
Duplicate (deep copy) http_content_md5_t.
Definition http_protos.h:13029
Returns
The function http_content_md5_dup() returns a pointer to the newly duplicated http_content_md5_t header structure, or NULL upon an error.

◆ http_content_md5_format()

http_content_md5_t * http_content_md5_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a Content-MD5 header from formatting result.

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

◆ http_content_md5_init()

http_content_md5_t * http_content_md5_init ( http_content_md5_t  x[1])
inline

Initialize a structure http_content_md5_t.

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

http_content_md5_t http_content_md5;
http_content_md5_init(&http_content_md5);
http_content_md5_t * http_content_md5_init(http_content_md5_t x[1])
Initialize a structure http_content_md5_t.
Definition http_protos.h:12858

◆ http_content_md5_make()

http_content_md5_t * http_content_md5_make ( su_home_t home,
char const *  s 
)
inline

Make a header structure http_content_md5_t.

The function http_content_md5_make() makes a new http_content_md5_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_content_md5_make() returns a pointer to newly maked http_content_md5_t header structure, or NULL upon an error.

◆ http_is_content_md5()

int http_is_content_md5 ( http_header_t const *  header)
inline

Test if header object is instance of http_content_md5_t.

The function http_is_content_md5() returns true (nonzero) if the header class is an instance of Content-MD5 header object and false (zero) otherwise.

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

Variable Documentation

◆ http_content_md5_class

msg_hclass_t http_content_md5_class[]
extern

Header class for HTTP Content-MD5 header.

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