sip 1.12.11devel
|
Data Structures | |
struct | sip_via_s |
Structure for Via header field. More... | |
Macros | |
#define | sip_via(sip) |
Access a SIP Via header structure sip_via_t from sip_t. | |
#define | SIP_VIA_INIT() |
Initializer for structure sip_via_t. | |
#define | SIPTAG_VIA(x) |
Tag list item for pointer to a Via header structure sip_via_t. | |
#define | SIPTAG_VIA_REF(x) |
Tag list item for reference to a Via header pointer. | |
#define | SIPTAG_VIA_STR(s) |
Tag list item for string with Via header value. | |
#define | SIPTAG_VIA_STR_REF(x) |
Tag list item for reference to a Via header string. | |
Functions | |
issize_t | sip_via_d (su_home_t *, msg_header_t *, char *s, isize_t slen) |
Parse a SIP Via header. | |
issize_t | sip_via_e (char b[], isize_t bsiz, msg_header_t const *h, int flags) |
Print a SIP Via header. | |
sip_via_t * | sip_via_init (sip_via_t x[1]) |
Initialize a structure sip_via_t. | |
int | sip_is_via (sip_header_t const *header) |
Test if header object is instance of sip_via_t. | |
sip_via_t * | sip_via_dup (su_home_t *home, sip_via_t const *hdr)) |
Duplicate a list of Via header header structures sip_via_t. | |
sip_via_t * | sip_via_copy (su_home_t *home, sip_via_t const *hdr)) |
Copy a list of Via header header structures sip_via_t. | |
sip_via_t * | sip_via_make (su_home_t *home, char const *s)) |
Make a Via header structure sip_via_t. | |
sip_via_t * | sip_via_format (su_home_t *home, char const *fmt,...))) |
Make a Via header from formatting result. | |
int | sip_via_add_param (su_home_t *home, sip_via_t *v, char const *param) |
Add a parameter to a Via object. | |
sip_via_t * | sip_via_create (su_home_t *home, char const *host, char const *port, char const *transport,...) |
Create a Via object. | |
char const * | sip_via_port (sip_via_t const *v, int *using_rport) |
Get port number corresponding to a Via line. | |
sip_via_t * | sip_via_remove (msg_t *msg, sip_t *sip) |
Get first via header and remove it from its fragment chain. | |
Variables | |
msg_hclass_t | sip_via_class [] |
Header class for Via header. | |
tag_typedef_t | siptag_via |
Tag for Via header object. | |
tag_typedef_t | siptag_via_str |
Tag for string with Via header value. | |
#define SIP_VIA_INIT | ( | ) |
Initializer for structure sip_via_t.
A static sip_via_t structure for Via header must be initialized with the SIP_VIA_INIT() macro. For instance,
#define SIPTAG_VIA | ( | x | ) |
Tag list item for pointer to a Via header structure sip_via_t.
The SIPTAG_VIA() macro is used to include a tag item with a pointer to a sip_via_t structure in a tag list.
x | pointer to a sip_via_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_VIA_REF().
#define SIPTAG_VIA_STR | ( | s | ) |
Tag list item for string with Via header value.
The SIPTAG_VIA_STR() macro is used to include a tag item with a string containing value of a sip_via_t header in a tag list.
s | pointer to a string containing Via header value, or NULL. |
The string in SIPTAG_VIA_STR() can be converted to a sip_via_t header structure by giving the string s has second argument to function sip_via_make().
The corresponding tag taking reference parameter is SIPTAG_VIA_STR_REF().
|
inline |
Test if header object is instance of sip_via_t.
Check if the header class is an instance of Via header object and return true (nonzero), otherwise return false (zero).
header | pointer to the header structure to be tested |
1 | (true) if the header is an instance of header via |
0 | (false) otherwise |
Add a parameter to a Via object.
Add a parameter to a Via header object.
param
.home | memory home |
v | sip_via_t object |
param | parameter string |
0 | when successful |
-1 | upon an error. |
Copy a list of Via header header structures sip_via_t.
The function sip_via_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.
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.
sip_via_t * sip_via_create | ( | su_home_t * | home, |
char const * | host, | ||
char const * | port, | ||
char const * | transport, | ||
... | |||
) |
Create a Via object.
Create a new Via header object with given parameters. If transport is NULL, the default transport "SIP/2.0/UDP" is used. A NULL-terminated list of parameters can be specified after transport.
home | memory home |
host | host name |
port | protocol port number |
transport | transport protocol (default is "SIP/2.0/UDP") |
... | NULL-terminated list of parameters |
Duplicate a list of Via header header structures sip_via_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.
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.
Make a Via header from formatting result.
Make a new sip_via_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_via_t.
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
Initialize a structure sip_via_t.
An sip_via_t structure for Via header can be initialized with the sip_via_init() function/macro. For instance,
Make a Via header structure sip_via_t.
The function sip_via_make() makes a new sip_via_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.
home | memory home used to allocate new header structure. |
s | string to be decoded as value of the new header structure |
char const * sip_via_port | ( | sip_via_t const * | v, |
int * | using_rport | ||
) |
Get port number corresponding to a Via line.
If using_rport is non-null, try rport. If *using_rport is non-zero, try rport even if <protocol> is not UDP. If <protocol> is UDP, set *using_rport to zero.
|
extern |
Header class for Via header.
The header class sip_via_class defines how a SIP Via header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_via_t header structure.