Collaboration diagram for Subscription-State Header:
![]() |
Its syntax is defined in RFC 3265 section 4.2.4 as follows:
Subscription-State = "Subscription-State" HCOLON substate-value *( SEMI subexp-params ) substate-value = "active" / "pending" / "terminated" / extension-substate extension-substate = token subexp-params = ("reason" EQUAL event-reason-value) / ("expires" EQUAL delta-seconds) / ("retry-after" EQUAL delta-seconds) / generic-param event-reason-value = "deactivated" / "probation" / "rejected" / "timeout" / "giveup" / "noresource" / event-reason-extension event-reason-extension = token
Data Structures | |
struct | sip_subscription_state_s |
Structure for Subscription-State header. More... | |
Defines | |
#define | sip_subscription_state(sip) |
Access a sip_subscription_state_t from sip_t. | |
#define | SIP_SUBSCRIPTION_STATE_INIT() |
Initializer for structure sip_subscription_state_t. | |
#define | SIPTAG_SUBSCRIPTION_STATE(x) |
Tag list item for pointer to a Subscription-State header structure. | |
#define | SIPTAG_SUBSCRIPTION_STATE_REF(x) |
Tag list item for reference to a a Subscription-State header pointer. | |
#define | SIPTAG_SUBSCRIPTION_STATE_STR(s) |
Tag list item for string with Subscription-State header value. | |
#define | SIPTAG_SUBSCRIPTION_STATE_STR_REF(x) |
Tag list item for reference to a a Subscription-State header string. | |
Typedefs | |
typedef sip_subscription_state_s | sip_subscription_state_t |
The structure sip_subscription_state_t contains representation of an Subscription-State header. | |
Enumerator | |
sip_subscription_state_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_subscription_state_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Subscription-State header. | |
SOFIAPUBFUN int | sip_subscription_state_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Subscription-State header. | |
sip_subscription_state_t * | sip_subscription_state_init (sip_subscription_state_t x[1]) |
Initialize a structure sip_subscription_state_t. | |
int | sip_is_subscription_state (sip_header_t const *header) |
Test if header object is instance of sip_subscription_state_t. | |
sip_subscription_state_t * | sip_subscription_state_dup (su_home_t *home, sip_subscription_state_t const *hdr)) |
Duplicate (deep copy) sip_subscription_state_t . | |
sip_subscription_state_t * | sip_subscription_state_copy (su_home_t *home, sip_subscription_state_t const *hdr)) |
Copy a sip_subscription_state_t header structure. | |
sip_subscription_state_t * | sip_subscription_state_make (su_home_t *home, char const *s)) |
Make a header structure sip_subscription_state_t. | |
sip_subscription_state_t * | sip_subscription_state_format (su_home_t *home, char const *fmt,...))) |
Make a Subscription-State header from formatting result. | |
Variables | |
tag_typedef_t | siptag_subscription_state |
Tag for Subscription-State header object. | |
tag_typedef_t | siptag_subscription_state_str |
Tag for string with Subscription-State header value. | |
msg_hclass_t | sip_subscription_state_class [] |
Header class for SIP Subscription-State header. |
#define SIP_SUBSCRIPTION_STATE_INIT | ( | ) |
Initializer for structure sip_subscription_state_t.
A static sip_subscription_state_t structure must be initialized. The SIP_SUBSCRIPTION_STATE_INIT() macro provides initialization value. For instance,
#define SIPTAG_SUBSCRIPTION_STATE | ( | x | ) |
Tag list item for pointer to a Subscription-State header structure.
The SIPTAG_SUBSCRIPTION_STATE() macro is used to include a tag item with a pointer to a sip_subscription_state_t object in a tag list.
x | pointer to a sip_subscription_state_t header structure, or NULL. |
#define SIPTAG_SUBSCRIPTION_STATE_STR | ( | s | ) |
Tag list item for string with Subscription-State header value.
The SIPTAG_SUBSCRIPTION_STATE_STR() macro is used to include a tag item with a string containing value of a sip_subscription_state_t header in a tag list.
s | pointer to a string containing sip_subscription_state_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SUBSCRIPTION_STATE_STR_REF().
The structure sip_subscription_state_t contains representation of an Subscription-State header.
The sip_subscription_state_t is defined as follows:
typedef struct sip_subscription_state_s { sip_common_t ss_common[1]; sip_unknown_t *ss_next; // Subscription state: "pending", "active" or "terminated" char const *ss_substate; msg_param_t const *ss_params; // List of parameters msg_param_t ss_reason; // Reason of terminating msg_param_t ss_expires; // Subscription lifetime in seconds msg_param_t ss_retry_after; // Value of retry-after parameter } sip_subscription_state_t;
sip_subscription_state_hash |
@
Hash of Subscription-State header.
int sip_is_subscription_state | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_subscription_state_t.
The function sip_is_subscription_state() returns true (nonzero) if the header class is an instance of Subscription-State header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_subscription_state_t * sip_subscription_state_copy | ( | su_home_t * | home, | |
sip_subscription_state_t const * | hdr | |||
) | [inline] |
Copy a sip_subscription_state_t header structure.
The function sip_subscription_state_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.
home | memory home used to allocate new structure | |
hdr | pointer to the header structure to be copied |
subscription_state = sip_subscription_state_copy(home, sip->sip_subscription_state);
sip_subscription_state_t * sip_subscription_state_dup | ( | su_home_t * | home, | |
sip_subscription_state_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_subscription_state_t
.
The function sip_subscription_state_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.
home | memory home used to allocate new structure | |
hdr | header structure to be duplicated |
subscription_state = sip_subscription_state_dup(home, sip->sip_subscription_state);
sip_subscription_state_t * sip_subscription_state_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Subscription-State header from formatting result.
The function sip_subscription_state_format() makes a new Subscription-State header 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.
home | memory home used to allocate new header structure. | |
fmt | string used as a printf()-style format | |
... | argument list for format |
sip_subscription_state_t* sip_subscription_state_init | ( | sip_subscription_state_t | x[1] | ) | [inline] |
Initialize a structure sip_subscription_state_t.
An sip_subscription_state_t structure can be initialized with the sip_subscription_state_init() function/macro. For instance,
sip_subscription_state_t * sip_subscription_state_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_subscription_state_t.
The function sip_subscription_state_make() makes a new sip_subscription_state_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 SIP Subscription-State header.
The header class sip_subscription_state_class defines how a SIP Subscription-State header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_subscription_state_t header structure.