http  1.13.16
Macros | Enumerations | Functions | Variables
Http_sec_websocket_protocol

Macros

#define HTTP_SEC_WEBSOCKET_PROTOCOL_INIT()
 Initializer for structure http_sec_websocket_protocol_t. More...
 
#define HTTPTAG_SEC_WEBSOCKET_PROTOCOL(x)
 Tag list item for pointer to a Sec-Websocket-Protocol header object. More...
 
#define HTTPTAG_SEC_WEBSOCKET_PROTOCOL_STR(s)
 Tag list item for string with Sec-Websocket-Protocol header value. More...
 

Enumerations

enum  { http_sec_websocket_protocol_hash }
 

Functions

http_sec_websocket_protocol_t * http_sec_websocket_protocol_init (http_sec_websocket_protocol_t x[1])
 Initialize a structure http_sec_websocket_protocol_t. More...
 
int http_is_sec_websocket_protocol (http_header_t const *header)
 Test if header object is instance of http_sec_websocket_protocol_t. More...
 
http_sec_websocket_protocol_t * http_sec_websocket_protocol_dup (su_home_t *home, http_sec_websocket_protocol_t const *hdr))
 Duplicate (deep copy) http_sec_websocket_protocol_t. More...
 
http_sec_websocket_protocol_t * http_sec_websocket_protocol_copy (su_home_t *home, http_sec_websocket_protocol_t const *hdr))
 Copy a http_sec_websocket_protocol_t header structure. More...
 
http_sec_websocket_protocol_t * http_sec_websocket_protocol_make (su_home_t *home, char const *s))
 Make a header structure http_sec_websocket_protocol_t. More...
 
http_sec_websocket_protocol_t * http_sec_websocket_protocol_format (su_home_t *home, char const *fmt,...)))
 Make a Sec-Websocket-Protocol header from formatting result. More...
 

Variables

msg_hclass_t http_sec_websocket_protocol_class []
 Header class for HTTP Sec-Websocket-Protocol header. More...
 
msg_parse_f http_sec_websocket_protocol_d
 Decode (parse) a Sec-Websocket-Protocol header.
 
msg_print_f http_sec_websocket_protocol_e
 Encode (print) a Sec-Websocket-Protocol header.
 

Detailed Description

Macro Definition Documentation

◆ HTTP_SEC_WEBSOCKET_PROTOCOL_INIT

#define HTTP_SEC_WEBSOCKET_PROTOCOL_INIT ( )

Initializer for structure http_sec_websocket_protocol_t.

A static http_sec_websocket_protocol_t structure must be initialized with the HTTP_SEC_WEBSOCKET_PROTOCOL_INIT() macro. For instance,

http_sec_websocket_protocol_t http_sec_websocket_protocol = HTTP_SEC_WEBSOCKET_PROTOCOL_INIT;
#define HTTP_SEC_WEBSOCKET_PROTOCOL_INIT()
Initializer for structure http_sec_websocket_protocol_t.
Definition: http_protos.h:12092

◆ HTTPTAG_SEC_WEBSOCKET_PROTOCOL

#define HTTPTAG_SEC_WEBSOCKET_PROTOCOL (   x)

Tag list item for pointer to a Sec-Websocket-Protocol header object.

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

Parameters
xpointer to a http_sec_websocket_protocol_t header structure, or NULL.

◆ HTTPTAG_SEC_WEBSOCKET_PROTOCOL_STR

#define HTTPTAG_SEC_WEBSOCKET_PROTOCOL_STR (   s)

Tag list item for string with Sec-Websocket-Protocol header value.

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

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

The HTTPTAG_SEC_WEBSOCKET_PROTOCOL_STR string can be converted to a http_sec_websocket_protocol_t header structure by giving the string s has second argument to function http_sec_websocket_protocol_make().

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
http_sec_websocket_protocol_hash 

Hash of Sec-Websocket-Protocol header.

Function Documentation

◆ http_is_sec_websocket_protocol()

int http_is_sec_websocket_protocol ( http_header_t const *  header)
inline

Test if header object is instance of http_sec_websocket_protocol_t.

The function http_is_sec_websocket_protocol() returns true (nonzero) if the header class is an instance of Sec-Websocket-Protocol header object and false (zero) otherwise.

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

◆ http_sec_websocket_protocol_copy()

http_sec_websocket_protocol_t * http_sec_websocket_protocol_copy ( su_home_t home,
http_sec_websocket_protocol_t const *  hdr 
)
inline

Copy a http_sec_websocket_protocol_t header structure.

The function http_sec_websocket_protocol_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
sec_websocket_protocol = http_sec_websocket_protocol_copy(home, http->http_sec_websocket_protocol);
http_sec_websocket_protocol_t * http_sec_websocket_protocol_copy(su_home_t *home, http_sec_websocket_protocol_t const *hdr))
Copy a http_sec_websocket_protocol_t header structure.
Definition: http_protos.h:12286
Returns
The function http_sec_websocket_protocol_copy() returns a pointer to newly copied header structure, or NULL upon an error.

◆ http_sec_websocket_protocol_dup()

http_sec_websocket_protocol_t * http_sec_websocket_protocol_dup ( su_home_t home,
http_sec_websocket_protocol_t const *  hdr 
)
inline

Duplicate (deep copy) http_sec_websocket_protocol_t.

The function http_sec_websocket_protocol_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
sec_websocket_protocol = http_sec_websocket_protocol_dup(home, http->http_sec_websocket_protocol);
http_sec_websocket_protocol_t * http_sec_websocket_protocol_dup(su_home_t *home, http_sec_websocket_protocol_t const *hdr))
Duplicate (deep copy) http_sec_websocket_protocol_t.
Definition: http_protos.h:12279
Returns
The function http_sec_websocket_protocol_dup() returns a pointer to the newly duplicated http_sec_websocket_protocol_t header structure, or NULL upon an error.

◆ http_sec_websocket_protocol_format()

http_sec_websocket_protocol_t * http_sec_websocket_protocol_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a Sec-Websocket-Protocol header from formatting result.

The function http_sec_websocket_protocol_format() makes a new Sec-Websocket-Protocol 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_sec_websocket_protocol_format() returns a pointer to newly makes header structure, or NULL upon an error.

◆ http_sec_websocket_protocol_init()

http_sec_websocket_protocol_t* http_sec_websocket_protocol_init ( http_sec_websocket_protocol_t  x[1])
inline

Initialize a structure http_sec_websocket_protocol_t.

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

http_sec_websocket_protocol_t http_sec_websocket_protocol;
http_sec_websocket_protocol_init(&http_sec_websocket_protocol);
http_sec_websocket_protocol_t * http_sec_websocket_protocol_init(http_sec_websocket_protocol_t x[1])
Initialize a structure http_sec_websocket_protocol_t.
Definition: http_protos.h:12108

◆ http_sec_websocket_protocol_make()

http_sec_websocket_protocol_t * http_sec_websocket_protocol_make ( su_home_t home,
char const *  s 
)
inline

Make a header structure http_sec_websocket_protocol_t.

The function http_sec_websocket_protocol_make() makes a new http_sec_websocket_protocol_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_sec_websocket_protocol_make() returns a pointer to newly maked http_sec_websocket_protocol_t header structure, or NULL upon an error.

Variable Documentation

◆ http_sec_websocket_protocol_class

msg_hclass_t http_sec_websocket_protocol_class[]
extern

Header class for HTTP Sec-Websocket-Protocol header.

The header class http_sec_websocket_protocol_class defines how a HTTP Sec-Websocket-Protocol header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_sec_websocket_protocol_t header structure.


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