Loading...
Searching...
No Matches
|
issize_t | sip_error_d (su_home_t *, msg_header_t *, char *s, isize_t slen) |
| Parse a SIP erroneous headers.
|
|
issize_t | sip_error_e (char b[], isize_t bsiz, msg_header_t const *h, int flags) |
| Print a SIP erroneous headers.
|
|
sip_error_t * | sip_error_init (sip_error_t x[1]) |
| Initialize a structure sip_error_t.
|
|
int | sip_is_error (sip_header_t const *header) |
| Test if header object is instance of sip_error_t.
|
|
sip_error_t * | sip_error_dup (su_home_t *home, sip_error_t const *hdr)) |
| Duplicate a list of erroneous headers header structures sip_error_t.
|
|
sip_error_t * | sip_error_copy (su_home_t *home, sip_error_t const *hdr)) |
| Copy a list of erroneous headers header structures sip_error_t.
|
|
sip_error_t * | sip_error_make (su_home_t *home, char const *s)) |
| Make a erroneous headers structure sip_error_t.
|
|
sip_error_t * | sip_error_format (su_home_t *home, char const *fmt,...))) |
| Make a erroneous headers from formatting result.
|
|
◆ SIP_ERROR_INIT
#define SIP_ERROR_INIT |
( |
| ) |
|
Initializer for structure sip_error_t.
A static sip_error_t structure for erroneous headers must be initialized with the SIP_ERROR_INIT() macro. For instance,
#define sip_error(sip)
Access a SIP erroneous headers structure sip_error_t from sip_t.
Definition sip_protos.h:16315
#define SIP_ERROR_INIT()
Initializer for structure sip_error_t.
Definition sip_protos.h:16332
◆ SIPTAG_ERROR
#define SIPTAG_ERROR |
( |
| x | ) |
|
◆ SIPTAG_ERROR_STR
#define SIPTAG_ERROR_STR |
( |
| s | ) |
|
◆ sip_error_t
@
The erroneous headers are stored in sip_error_t structure.
- Note
- Other headers (like duplicate Content-Length headers) may be put into the list of erroneous headers (
sip->sip_error
). If the list of erroneous headers is processed, the header type must be validated first by calling sip_is_error() (or by other relevant tests).
The structure sip_error_t contains representation of error headers.
The sip_error_t is defined as follows:
msg_error_t sip_error_t
@
Definition sip.h:134
msg_common_t er_common[1]
◆ sip_error_copy()
Copy a list of erroneous headers header structures sip_error_t.
The function sip_error_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 list of header structure hdr.
- Parameters
-
home | memory home used to allocate new structure |
hdr | pointer to the header structure to be copied |
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 hdr header, including the encoding of the old header, if present.
- Example
sip_error_t * sip_error_copy(su_home_t *home, sip_error_t const *hdr))
Copy a list of erroneous headers header structures sip_error_t.
Definition sip_protos.h:16462
- Returns
- A pointer to newly copied header structure, or NULL upon an error.
◆ sip_error_dup()
Duplicate a list of erroneous headers header structures sip_error_t.
Duplicate 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
sip_error_t * sip_error_dup(su_home_t *home, sip_error_t const *hdr))
Duplicate a list of erroneous headers header structures sip_error_t.
Definition sip_protos.h:16419
- Returns
- A pointer to the newly duplicated sip_error_t header structure, or NULL upon an error.
◆ sip_error_format()
Make a erroneous headers from formatting result.
Make a new sip_error_t 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 parses the formatting result to the structure sip_error_t.
- Parameters
-
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
- Returns
- A pointer to newly makes header structure, or NULL upon an error.
◆ sip_error_init()
◆ sip_error_make()
Make a erroneous headers structure sip_error_t.
The function sip_error_make() makes a new sip_error_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 |
- Returns
- A pointer to newly maked sip_error_t header structure, or NULL upon an error.
◆ sip_is_error()
Test if header object is instance of sip_error_t.
Check if the header class is an instance of erroneous headers object and return true (nonzero), otherwise return false (zero).
- Parameters
-
header | pointer to the header structure to be tested |
- Return values
-
1 | (true) if the header is an instance of header error |
0 | (false) otherwise |
◆ sip_error_class
Header class for erroneous headers.
The header class sip_error_class defines how a SIP erroneous headers is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_error_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.