Collaboration diagram for Status Line:
![]() |
It is defined in [S9.1] as follows:
Status-Line = SIP-Version SP Status-Code SP Reason-Phrase CRLF Status-Code = Informational / Redirection / Success / Client-Error / Server-Error / Global-Failure / extension-code extension-code = 3DIGIT Reason-Phrase = *(reserved / unreserved / escaped / UTF8-NONASCII / UTF8-CONT / SP / HTAB)
Data Structures | |
struct | sip_status_s |
Structure for SIP status line. More... | |
Defines | |
#define | sip_status(sip) |
Access a sip_status_t from sip_t. | |
#define | SIP_STATUS_INIT() |
Initializer for structure sip_status_t. | |
#define | SIPTAG_STATUS(x) |
Tag list item for pointer to a status line structure. | |
#define | SIPTAG_STATUS_REF(x) |
Tag list item for reference to a a status line pointer. | |
#define | SIPTAG_STATUS_STR(s) |
Tag list item for string with status line value. | |
#define | SIPTAG_STATUS_STR_REF(x) |
Tag list item for reference to a a status line string. | |
Typedefs | |
typedef sip_status_s | sip_status_t |
Status line. | |
Enumerator | |
sip_status_hash | |
@ | |
Functions | |
sip_status_t * | sip_status_create (su_home_t *home, unsigned status, char const *phrase, char const *version) |
Create a status line object. | |
SOFIAPUBFUN int | sip_status_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a status line. | |
SOFIAPUBFUN int | sip_status_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a status line. | |
sip_status_t * | sip_status_init (sip_status_t x[1]) |
Initialize a structure sip_status_t. | |
int | sip_is_status (sip_header_t const *header) |
Test if header object is instance of sip_status_t. | |
sip_status_t * | sip_status_dup (su_home_t *home, sip_status_t const *hdr)) |
Duplicate (deep copy) sip_status_t . | |
sip_status_t * | sip_status_copy (su_home_t *home, sip_status_t const *hdr)) |
Copy a sip_status_t header structure. | |
sip_status_t * | sip_status_make (su_home_t *home, char const *s)) |
Make a header structure sip_status_t. | |
sip_status_t * | sip_status_format (su_home_t *home, char const *fmt,...))) |
Make a status line from formatting result. | |
Variables | |
tag_typedef_t | siptag_status |
Tag for status line object. | |
tag_typedef_t | siptag_status_str |
Tag for string with status line value. | |
msg_hclass_t | sip_status_class [] |
Header class for SIP status line. |
#define SIP_STATUS_INIT | ( | ) |
Initializer for structure sip_status_t.
A static sip_status_t structure must be initialized. The SIP_STATUS_INIT() macro provides initialization value. For instance,
#define SIPTAG_STATUS | ( | x | ) |
Tag list item for pointer to a status line structure.
The SIPTAG_STATUS() macro is used to include a tag item with a pointer to a sip_status_t object in a tag list.
x | pointer to a sip_status_t header structure, or NULL. |
#define SIPTAG_STATUS_STR | ( | s | ) |
Tag list item for string with status line value.
The SIPTAG_STATUS_STR() macro is used to include a tag item with a string containing value of a sip_status_t header in a tag list.
s | pointer to a string containing sip_status_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_STATUS_STR_REF().
typedef struct sip_status_s sip_status_t |
Status line.
The sip_status_t is defined as follows:
typedef struct sip_status_s { sip_common_t st_common[1]; // Common fragment info sip_unknown_t *st_next; // Link to next (dummy) char const *st_version; // Protocol version int st_status; // Status code char const *st_phrase; // Status phrase } sip_status_t;
sip_status_hash |
@
Hash of status line.
int sip_is_status | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_status_t.
The function sip_is_status() returns true (nonzero) if the header class is an instance of status line object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_status_t * sip_status_copy | ( | su_home_t * | home, | |
sip_status_t const * | hdr | |||
) | [inline] |
Copy a sip_status_t header structure.
The function sip_status_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 |
status = sip_status_copy(home, sip->sip_status);
sip_status_t* sip_status_create | ( | su_home_t * | home, | |
unsigned | status, | |||
char const * | phrase, | |||
char const * | version | |||
) |
Create a status line object.
home | memory home used to allocate sip_status_t object | |
status | status code (in range 100 - 699) | |
phrase | status phrase (may be NULL) | |
version | version string (defaults to "SIP/2.0" if NULL) |
sip_status_t * sip_status_dup | ( | su_home_t * | home, | |
sip_status_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_status_t
.
The function sip_status_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 |
status = sip_status_dup(home, sip->sip_status);
sip_status_t * sip_status_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a status line from formatting result.
The function sip_status_format() makes a new status line 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_status_t* sip_status_init | ( | sip_status_t | x[1] | ) | [inline] |
Initialize a structure sip_status_t.
An sip_status_t structure can be initialized with the sip_status_init() function/macro. For instance,
sip_status_t * sip_status_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_status_t.
The function sip_status_make() makes a new sip_status_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 status line.
The header class sip_status_class defines how a SIP status line is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_status_t header structure.