Collaboration diagram for Retry-After Header:
![]() |
Its syntax is defined in [RFC3261] as follows:
Retry-After = "Retry-After" HCOLON delta-seconds [ comment ] *( SEMI retry-param ) retry-param = ("duration" EQUAL delta-seconds) / generic-param
Data Structures | |
struct | sip_retry_after_s |
Structure for Retry-After header. More... | |
Defines | |
#define | sip_retry_after(sip) |
Access a sip_retry_after_t from sip_t. | |
#define | SIP_RETRY_AFTER_INIT() |
Initializer for structure sip_retry_after_t. | |
#define | SIPTAG_RETRY_AFTER(x) |
Tag list item for pointer to a Retry-After header structure. | |
#define | SIPTAG_RETRY_AFTER_REF(x) |
Tag list item for reference to a a Retry-After header pointer. | |
#define | SIPTAG_RETRY_AFTER_STR(s) |
Tag list item for string with Retry-After header value. | |
#define | SIPTAG_RETRY_AFTER_STR_REF(x) |
Tag list item for reference to a a Retry-After header string. | |
Typedefs | |
typedef sip_retry_after_s | sip_retry_after_t |
The structure sip_retry_after_t contains representation of an Retry-After header. | |
Enumerator | |
sip_retry_after_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_retry_after_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Retry-After header. | |
SOFIAPUBFUN int | sip_retry_after_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Retry-After header. | |
sip_retry_after_t * | sip_retry_after_init (sip_retry_after_t x[1]) |
Initialize a structure sip_retry_after_t. | |
int | sip_is_retry_after (sip_header_t const *header) |
Test if header object is instance of sip_retry_after_t. | |
sip_retry_after_t * | sip_retry_after_dup (su_home_t *home, sip_retry_after_t const *hdr)) |
Duplicate (deep copy) sip_retry_after_t . | |
sip_retry_after_t * | sip_retry_after_copy (su_home_t *home, sip_retry_after_t const *hdr)) |
Copy a sip_retry_after_t header structure. | |
sip_retry_after_t * | sip_retry_after_make (su_home_t *home, char const *s)) |
Make a header structure sip_retry_after_t. | |
sip_retry_after_t * | sip_retry_after_format (su_home_t *home, char const *fmt,...))) |
Make a Retry-After header from formatting result. | |
Variables | |
tag_typedef_t | siptag_retry_after |
Tag for Retry-After header object. | |
tag_typedef_t | siptag_retry_after_str |
Tag for string with Retry-After header value. | |
msg_hclass_t | sip_retry_after_class [] |
Header class for SIP Retry-After header. |
#define SIP_RETRY_AFTER_INIT | ( | ) |
Initializer for structure sip_retry_after_t.
A static sip_retry_after_t structure must be initialized. The SIP_RETRY_AFTER_INIT() macro provides initialization value. For instance,
#define SIPTAG_RETRY_AFTER | ( | x | ) |
Tag list item for pointer to a Retry-After header structure.
The SIPTAG_RETRY_AFTER() macro is used to include a tag item with a pointer to a sip_retry_after_t object in a tag list.
x | pointer to a sip_retry_after_t header structure, or NULL. |
#define SIPTAG_RETRY_AFTER_STR | ( | s | ) |
Tag list item for string with Retry-After header value.
The SIPTAG_RETRY_AFTER_STR() macro is used to include a tag item with a string containing value of a sip_retry_after_t header in a tag list.
s | pointer to a string containing sip_retry_after_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_RETRY_AFTER_STR_REF().
The structure sip_retry_after_t contains representation of an Retry-After header.
The sip_retry_after_t is defined as follows:
typedef struct sip_retry_after_s { sip_common_t af_common[1]; // Common fragment info sip_error_t *af_next; // Link to next (dummy) sip_time_t af_delta; // Seconds to before retry msg_param_t af_comment; // Comment string msg_param_t const *af_params; // List of parameters msg_param_t af_duration; // Duration parameter } sip_retry_after_t;
sip_retry_after_hash |
@
Hash of Retry-After header.
int sip_is_retry_after | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_retry_after_t.
The function sip_is_retry_after() returns true (nonzero) if the header class is an instance of Retry-After header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_retry_after_t * sip_retry_after_copy | ( | su_home_t * | home, | |
sip_retry_after_t const * | hdr | |||
) | [inline] |
Copy a sip_retry_after_t header structure.
The function sip_retry_after_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 |
retry_after = sip_retry_after_copy(home, sip->sip_retry_after);
sip_retry_after_t * sip_retry_after_dup | ( | su_home_t * | home, | |
sip_retry_after_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_retry_after_t
.
The function sip_retry_after_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 |
retry_after = sip_retry_after_dup(home, sip->sip_retry_after);
sip_retry_after_t * sip_retry_after_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Retry-After header from formatting result.
The function sip_retry_after_format() makes a new Retry-After 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_retry_after_t* sip_retry_after_init | ( | sip_retry_after_t | x[1] | ) | [inline] |
Initialize a structure sip_retry_after_t.
An sip_retry_after_t structure can be initialized with the sip_retry_after_init() function/macro. For instance,
sip_retry_after_t * sip_retry_after_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_retry_after_t.
The function sip_retry_after_make() makes a new sip_retry_after_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 Retry-After header.
The header class sip_retry_after_class defines how a SIP Retry-After header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_retry_after_t header structure.