Collaboration diagram for Organization Header:
![]() |
Its syntax is defined in [S10.29] as follows:
Organization = "Organization" HCOLON [TEXT-UTF8-TRIM]
Defines | |
#define | sip_organization(sip) |
Access a sip_organization_t from sip_t. | |
#define | SIP_ORGANIZATION_INIT() |
Initializer for structure sip_organization_t. | |
#define | SIPTAG_ORGANIZATION(x) |
Tag list item for pointer to a Organization header structure. | |
#define | SIPTAG_ORGANIZATION_REF(x) |
Tag list item for reference to a a Organization header pointer. | |
#define | SIPTAG_ORGANIZATION_STR(s) |
Tag list item for string with Organization header value. | |
#define | SIPTAG_ORGANIZATION_STR_REF(x) |
Tag list item for reference to a a Organization header string. | |
Enumerator | |
sip_organization_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_organization_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Organization header. | |
SOFIAPUBFUN int | sip_organization_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Organization header. | |
sip_organization_t * | sip_organization_init (sip_organization_t x[1]) |
Initialize a structure sip_organization_t. | |
int | sip_is_organization (sip_header_t const *header) |
Test if header object is instance of sip_organization_t. | |
sip_organization_t * | sip_organization_dup (su_home_t *home, sip_organization_t const *hdr)) |
Duplicate (deep copy) sip_organization_t . | |
sip_organization_t * | sip_organization_copy (su_home_t *home, sip_organization_t const *hdr)) |
Copy a sip_organization_t header structure. | |
sip_organization_t * | sip_organization_make (su_home_t *home, char const *s)) |
Make a header structure sip_organization_t. | |
sip_organization_t * | sip_organization_format (su_home_t *home, char const *fmt,...))) |
Make a Organization header from formatting result. | |
Variables | |
tag_typedef_t | siptag_organization |
Tag for Organization header object. | |
tag_typedef_t | siptag_organization_str |
Tag for string with Organization header value. | |
msg_hclass_t | sip_organization_class [] |
Header class for SIP Organization header. |
#define SIP_ORGANIZATION_INIT | ( | ) |
Initializer for structure sip_organization_t.
A static sip_organization_t structure must be initialized. The SIP_ORGANIZATION_INIT() macro provides initialization value. For instance,
#define SIPTAG_ORGANIZATION | ( | x | ) |
Tag list item for pointer to a Organization header structure.
The SIPTAG_ORGANIZATION() macro is used to include a tag item with a pointer to a sip_organization_t object in a tag list.
x | pointer to a sip_organization_t header structure, or NULL. |
#define SIPTAG_ORGANIZATION_STR | ( | s | ) |
Tag list item for string with Organization header value.
The SIPTAG_ORGANIZATION_STR() macro is used to include a tag item with a string containing value of a sip_organization_t header in a tag list.
s | pointer to a string containing sip_organization_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_ORGANIZATION_STR_REF().
sip_organization_hash |
@
Hash of Organization header.
int sip_is_organization | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_organization_t.
The function sip_is_organization() returns true (nonzero) if the header class is an instance of Organization header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_organization_t * sip_organization_copy | ( | su_home_t * | home, | |
sip_organization_t const * | hdr | |||
) | [inline] |
Copy a sip_organization_t header structure.
The function sip_organization_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 |
organization = sip_organization_copy(home, sip->sip_organization);
sip_organization_t * sip_organization_dup | ( | su_home_t * | home, | |
sip_organization_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_organization_t
.
The function sip_organization_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 |
organization = sip_organization_dup(home, sip->sip_organization);
sip_organization_t * sip_organization_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Organization header from formatting result.
The function sip_organization_format() makes a new Organization 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_organization_t* sip_organization_init | ( | sip_organization_t | x[1] | ) | [inline] |
Initialize a structure sip_organization_t.
An sip_organization_t structure can be initialized with the sip_organization_init() function/macro. For instance,
sip_organization_t * sip_organization_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_organization_t.
The function sip_organization_make() makes a new sip_organization_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 Organization header.
The header class sip_organization_class defines how a SIP Organization header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_organization_t header structure.