The From header indicates the initiator of the request.
More...
|
issize_t | sip_from_d (su_home_t *, msg_header_t *, char *s, isize_t slen) |
| Parse a SIP From header.
|
|
issize_t | sip_from_e (char b[], isize_t bsiz, msg_header_t const *h, int flags) |
| Print a SIP From header.
|
|
sip_from_t * | sip_from_init (sip_from_t x[1]) |
| Initialize a structure sip_from_t. More...
|
|
int | sip_is_from (sip_header_t const *header) |
| Test if header object is instance of sip_from_t. More...
|
|
sip_from_t * | sip_from_dup (su_home_t *home, sip_from_t const *hdr)) |
| Duplicate a list of From header header structures sip_from_t. More...
|
|
sip_from_t * | sip_from_copy (su_home_t *home, sip_from_t const *hdr)) |
| Copy a list of From header header structures sip_from_t. More...
|
|
sip_from_t * | sip_from_make (su_home_t *home, char const *s)) |
| Make a From header structure sip_from_t. More...
|
|
sip_from_t * | sip_from_format (su_home_t *home, char const *fmt,...))) |
| Make a From header from formatting result. More...
|
|
sip_from_t * | sip_from_create (su_home_t *home, url_string_t const *s) |
| Create a From header object with URL. More...
|
|
int | sip_from_add_param (su_home_t *home, sip_from_t *from, char const *param) |
| Add a parameter to an sip_from_t object. More...
|
|
int | sip_from_tag (su_home_t *home, sip_from_t *from, char const *tag) |
| Add a tag to a From header. More...
|
|
The From header indicates the initiator of the request.
It is defined in RFC 3261 as follows:
From = ( "From" / "f" ) HCOLON from-spec
from-spec = ( name-addr / addr-spec )
*( SEMI from-param )
from-param = tag-param / generic-param
tag-param = "tag" EQUAL token
The parsed From header is stored in sip_from_t structure.
§ SIP_FROM_INIT
#define SIP_FROM_INIT |
( |
| ) |
|
§ SIPTAG_FROM
§ SIPTAG_FROM_STR
#define SIPTAG_FROM_STR |
( |
|
s | ) |
|
§ sip_from_t
§ sip_from_add_param()
§ sip_from_copy()
Copy a list of From header header structures sip_from_t.
The function sip_from_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
- Returns
- A pointer to newly copied header structure, or NULL upon an error.
§ sip_from_create()
Create a From header object with URL.
Create a From header object.
- Parameters
-
home | memory home used to allocate sip_from_t structure |
s | pointer to the URL or a string |
- Returns
- A pointer to newly created From header object when successful or NULL upon an error.
§ sip_from_dup()
Duplicate a list of From header header structures sip_from_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
- Returns
- A pointer to the newly duplicated sip_from_t header structure, or NULL upon an error.
§ sip_from_format()
Make a From header from formatting result.
Make a new sip_from_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_from_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_from_init()
§ sip_from_make()
Make a From header structure sip_from_t.
The function sip_from_make() makes a new sip_from_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_from_t header structure, or NULL upon an error.
§ sip_from_tag()
Add a tag to a From header.
If tag is identical with the existing one, nothing will be done. An error is returned, if the header already contains a different tag. The tag can be provided either as a single token ("deadbeer") or as in parameter form ("tag=deadbeer"). In both cases the tag is duplicated using the memory home home.
- Parameters
-
home | memory home used to allocate new tag |
from | From header to modify |
tag | tag token or parameter to be added |
- Return values
-
0 | when successful |
-1 | upon an error. |
§ sip_is_from()
Test if header object is instance of sip_from_t.
Check if the header class is an instance of From header 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 from |
0 | (false) otherwise |
§ sip_from_class
Header class for From header.
The header class sip_from_class defines how a SIP From header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_from_t header structure.