Loading...
Searching...
No Matches
|
msg_hclass_t | http_request_class [] |
| Header class for HTTP request line.
|
|
msg_parse_f | http_request_d |
| Decode (parse) a request line.
|
|
msg_print_f | http_request_e |
| Encode (print) a request line.
|
|
◆ HTTP_REQUEST_INIT
#define HTTP_REQUEST_INIT |
( |
| ) |
|
Initializer for structure http_request_t.
A static http_request_t structure must be initialized with the HTTP_REQUEST_INIT() macro. For instance,
#define HTTP_REQUEST_INIT()
Initializer for structure http_request_t.
Definition http_protos.h:92
HTTP request line.
Definition http.h:179
◆ HTTPTAG_REQUEST
#define HTTPTAG_REQUEST |
( |
| x | ) |
|
Tag list item for pointer to a request line object.
The HTTPTAG_REQUEST() macro is used to include a tag item with a pointer to a http_request_t object in a tag list.
- Parameters
-
x | pointer to a http_request_t header structure, or NULL. |
◆ HTTPTAG_REQUEST_STR
#define HTTPTAG_REQUEST_STR |
( |
| s | ) |
|
Tag list item for string with request line value.
The HTTPTAG_REQUEST_STR() macro is used to include a tag item with a string containing value of a http_request_t header in a tag list.
- Parameters
-
s | pointer to a string containing http_request_t value, or NULL. |
The HTTPTAG_REQUEST_STR string can be converted to a http_request_t header structure by giving the string s has second argument to function http_request_make().
◆ anonymous enum
Enumerator |
---|
http_request_hash | Hash of request line.
|
◆ http_is_request()
Test if header object is instance of http_request_t.
The function http_is_request() returns true (nonzero) if the header class is an instance of request line object and false (zero) otherwise.
- Parameters
-
header | pointer to the header structure to be tested |
- Returns
- The function http_is_xrequest() returns true (nonzero) if the header object is an instance of header request and false (zero) otherwise.
◆ http_request_copy()
Copy a http_request_t header structure.
The function http_request_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
-
home | memory home used to allocate new structure |
hdr | pointer 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
http_request_t * http_request_copy(su_home_t *home, http_request_t const *hdr))
Copy a http_request_t header structure.
Definition http_protos.h:286
- Returns
- The function http_request_copy() returns a pointer to newly copied header structure, or NULL upon an error.
◆ http_request_dup()
Duplicate (deep copy) http_request_t
.
The function http_request_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
-
home | memory home used to allocate new structure |
hdr | header 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
http_request_t * http_request_dup(su_home_t *home, http_request_t const *hdr))
Duplicate (deep copy) http_request_t.
Definition http_protos.h:279
- Returns
- The function http_request_dup() returns a pointer to the newly duplicated http_request_t header structure, or NULL upon an error.
◆ http_request_format()
Make a request line from formatting result.
The function http_request_format() makes a new request line 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
-
home | memory home used to allocate new header structure. |
fmt | string 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_request_format() returns a pointer to newly makes header structure, or NULL upon an error.
◆ http_request_init()
Initialize a structure http_request_t.
An http_request_t structure can be initialized with the http_request_init() function/macro. For instance,
http_request_t * http_request_init(http_request_t x[1])
Initialize a structure http_request_t.
Definition http_protos.h:108
◆ http_request_make()
Make a header structure http_request_t.
The function http_request_make() makes a new http_request_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.
- Parameters
-
home | memory home used to allocate new header structure. |
s | string 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_request_make() returns a pointer to newly maked http_request_t header structure, or NULL upon an error.
◆ http_request_class
Header class for HTTP request line.
The header class http_request_class defines how a HTTP request line is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_request_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.