Collaboration diagram for Content-Length Header:
![]() |
Its syntax is defined in [S10.18] as follows:
Content-Length = ( "Content-Length" / "l" ) HCOLON 1*DIGIT
Data Structures | |
struct | sip_content_length_s |
Structure for Content-Length header. More... | |
Defines | |
#define | sip_content_length(sip) |
Access a sip_content_length_t from sip_t. | |
#define | SIP_CONTENT_LENGTH_INIT() |
Initializer for structure sip_content_length_t. | |
#define | SIPTAG_CONTENT_LENGTH(x) |
Tag list item for pointer to a Content-Length header structure. | |
#define | SIPTAG_CONTENT_LENGTH_REF(x) |
Tag list item for reference to a a Content-Length header pointer. | |
#define | SIPTAG_CONTENT_LENGTH_STR(s) |
Tag list item for string with Content-Length header value. | |
#define | SIPTAG_CONTENT_LENGTH_STR_REF(x) |
Tag list item for reference to a a Content-Length header string. | |
Typedefs | |
typedef sip_content_length_s | sip_content_length_t |
The structure sip_content_length_t contains representation of SIP Content-Length header. | |
Enumerator | |
sip_content_length_hash | |
@ | |
Functions | |
sip_content_length_t * | sip_content_length_create (su_home_t *home, uint32_t n) |
Create a Content-Length header object. | |
SOFIAPUBFUN int | sip_content_length_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Content-Length header. | |
SOFIAPUBFUN int | sip_content_length_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Content-Length header. | |
sip_content_length_t * | sip_content_length_init (sip_content_length_t x[1]) |
Initialize a structure sip_content_length_t. | |
int | sip_is_content_length (sip_header_t const *header) |
Test if header object is instance of sip_content_length_t. | |
sip_content_length_t * | sip_content_length_dup (su_home_t *home, sip_content_length_t const *hdr)) |
Duplicate (deep copy) sip_content_length_t . | |
sip_content_length_t * | sip_content_length_copy (su_home_t *home, sip_content_length_t const *hdr)) |
Copy a sip_content_length_t header structure. | |
sip_content_length_t * | sip_content_length_make (su_home_t *home, char const *s)) |
Make a header structure sip_content_length_t. | |
sip_content_length_t * | sip_content_length_format (su_home_t *home, char const *fmt,...))) |
Make a Content-Length header from formatting result. | |
Variables | |
tag_typedef_t | siptag_content_length |
Tag for Content-Length header object. | |
tag_typedef_t | siptag_content_length_str |
Tag for string with Content-Length header value. | |
msg_hclass_t | sip_content_length_class [] |
Header class for SIP Content-Length header. |
#define SIP_CONTENT_LENGTH_INIT | ( | ) |
Initializer for structure sip_content_length_t.
A static sip_content_length_t structure must be initialized. The SIP_CONTENT_LENGTH_INIT() macro provides initialization value. For instance,
#define SIPTAG_CONTENT_LENGTH | ( | x | ) |
Tag list item for pointer to a Content-Length header structure.
The SIPTAG_CONTENT_LENGTH() macro is used to include a tag item with a pointer to a sip_content_length_t object in a tag list.
x | pointer to a sip_content_length_t header structure, or NULL. |
#define SIPTAG_CONTENT_LENGTH_STR | ( | s | ) |
Tag list item for string with Content-Length header value.
The SIPTAG_CONTENT_LENGTH_STR() macro is used to include a tag item with a string containing value of a sip_content_length_t header in a tag list.
s | pointer to a string containing sip_content_length_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_CONTENT_LENGTH_STR_REF().
typedef struct sip_content_length_s sip_content_length_t |
The structure sip_content_length_t contains representation of SIP Content-Length header.
The sip_content_length_t is defined as follows:
typedef struct sip_content_length_s { sip_common_t l_common[1]; // Common fragment info sip_unknown_t *l_next; // Link to next (dummy) unsigned long l_length; // Digits } sip_content_length_t;
sip_content_length_hash |
@
Hash of Content-Length header.
sip_content_length_t * sip_content_length_copy | ( | su_home_t * | home, | |
sip_content_length_t const * | hdr | |||
) | [inline] |
Copy a sip_content_length_t header structure.
The function sip_content_length_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 |
content_length = sip_content_length_copy(home, sip->sip_content_length);
sip_content_length_t* sip_content_length_create | ( | su_home_t * | home, | |
uint32_t | n | |||
) |
Create a Content-Length header object.
The function sip_content_length_create() creates a Content-Length header object with the value n. The memory for the header is allocated from the memory home home.
home | memory home | |
n | payload size in bytes |
sip_content_length_t * sip_content_length_dup | ( | su_home_t * | home, | |
sip_content_length_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_content_length_t
.
The function sip_content_length_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 |
content_length = sip_content_length_dup(home, sip->sip_content_length);
sip_content_length_t * sip_content_length_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Content-Length header from formatting result.
The function sip_content_length_format() makes a new Content-Length 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_content_length_t* sip_content_length_init | ( | sip_content_length_t | x[1] | ) | [inline] |
Initialize a structure sip_content_length_t.
An sip_content_length_t structure can be initialized with the sip_content_length_init() function/macro. For instance,
sip_content_length_t * sip_content_length_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_content_length_t.
The function sip_content_length_make() makes a new sip_content_length_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 |
int sip_is_content_length | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_content_length_t.
The function sip_is_content_length() returns true (nonzero) if the header class is an instance of Content-Length header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Content-Length header.
The header class sip_content_length_class defines how a SIP Content-Length header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_content_length_t header structure.