SIP header field Refer-Sub is meaningful and MAY be used with a REFER request and the corresponding 2XX response only. More...
SIP header field Refer-Sub is meaningful and MAY be used with a REFER request and the corresponding 2XX response only.
This header field set to "false" specifies that a REFER-Issuer requests that the REFER-Recipient doesn't establish an implicit subscription and the resultant dialog.
Refer-Sub = "Refer-Sub" HCOLON refer-sub-value *(SEMI exten) refer-sub-value = "true" / "false" exten = generic-param
The parsed Refer-Sub header is stored in sip_refer_sub_t structure.
| #define sip_refer_sub | ( | sip | ) |
Access a SIP Refer-Sub header structure sip_refer_sub_t from sip_t.
| #define SIP_REFER_SUB_INIT | ( | ) |
Initializer for structure sip_refer_sub_t.
A static sip_refer_sub_t structure for Refer-Sub header must be initialized with the SIP_REFER_SUB_INIT() macro. For instance,
sip_refer_sub_t sip_refer_sub = SIP_REFER_SUB_INIT;
| #define SIPTAG_REFER_SUB | ( | x | ) |
Tag list item for pointer to a Refer-Sub header structure sip_refer_sub_t.
The SIPTAG_REFER_SUB() macro is used to include a tag item with a pointer to a sip_refer_sub_t structure in a tag list.
| x | pointer to a sip_refer_sub_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_REFER_SUB_REF().
| #define SIPTAG_REFER_SUB_STR | ( | s | ) |
Tag list item for string with Refer-Sub header value.
The SIPTAG_REFER_SUB_STR() macro is used to include a tag item with a string containing value of a sip_refer_sub_t header in a tag list.
| s | pointer to a string containing Refer-Sub header value, or NULL. |
The string in SIPTAG_REFER_SUB_STR() can be converted to a sip_refer_sub_t header structure by giving the string s has second argument to function sip_refer_sub_make().
The corresponding tag taking reference parameter is SIPTAG_REFER_SUB_STR_REF().
| typedef struct sip_refer_sub_s sip_refer_sub_t |
The structure sip_refer_sub_t contains representation of Refer-Sub header.
The sip_refer_sub_t is defined as follows:
typedef struct sip_refer_sub_s { sip_common_t rs_common[1]; // Common fragment info sip_error_t *rs_next; // Dummy link to next char const *rs_value; // "true" or "false" msg_param_t const *rs_params; // List of extension parameters } sip_refer_sub_t;
| int sip_is_refer_sub | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_refer_sub_t.
Check if the header class is an instance of Refer-Sub 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 refer_sub | |
| 0 | (false) otherwise |
| sip_refer_sub_t * sip_refer_sub_copy | ( | su_home_t * | home, | |
| sip_refer_sub_t const * | hdr | |||
| ) | [inline] |
Copy a list of Refer-Sub header header structures sip_refer_sub_t.
The function sip_refer_sub_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.
refer_sub = sip_refer_sub_copy(home, sip->sip_refer_sub);
| sip_refer_sub_t * sip_refer_sub_dup | ( | su_home_t * | home, | |
| sip_refer_sub_t const * | hdr | |||
| ) | [inline] |
Duplicate a list of Refer-Sub header header structures sip_refer_sub_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.
refer_sub = sip_refer_sub_dup(home, sip->sip_refer_sub);
| sip_refer_sub_t * sip_refer_sub_format | ( | su_home_t * | home, | |
| char const * | fmt, | |||
| ... | ||||
| ) | [inline] |
Make a Refer-Sub header from formatting result.
Make a new sip_refer_sub_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_refer_sub_t.
| home | memory home used to allocate new header structure. | |
| fmt | string used as a printf()-style format | |
| ... | argument list for format |
| sip_refer_sub_t* sip_refer_sub_init | ( | sip_refer_sub_t | x[1] | ) | [inline] |
Initialize a structure sip_refer_sub_t.
An sip_refer_sub_t structure for Refer-Sub header can be initialized with the sip_refer_sub_init() function/macro. For instance,
sip_refer_sub_t sip_refer_sub; sip_refer_sub_init(&sip_refer_sub);
| sip_refer_sub_t * sip_refer_sub_make | ( | su_home_t * | home, | |
| char const * | s | |||
| ) | [inline] |
Make a Refer-Sub header structure sip_refer_sub_t.
The function sip_refer_sub_make() makes a new sip_refer_sub_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 |
Header class for Refer-Sub header.
The header class sip_refer_sub_class defines how a SIP Refer-Sub header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_refer_sub_t header structure.
