Collaboration diagram for Referred-By Header:
![]() |
Its syntax is defined in draft-ietf-sip-referredby-03 section 3 as follows:
Referred-By = ("Referred-By" / "b") HCOLON referrer-uri *( SEMI (referredby-id-param / generic-param) ) referrer-uri = ( name-addr / addr-spec ) referredby-id-param = "cid" EQUAL sip-clean-msg-id sip-clean-msg-id = LDQUOT dot-atom "@" (dot-atom / host) RDQUOT dot-atom = atom *( "." atom ) atom = 1*( alphanum / "-" / "!" / "%" / "*" / "_" / "+" / "'" / "`" / "~" )
Data Structures | |
struct | sip_referred_by_s |
Structure for Referred-By header. More... | |
Defines | |
#define | sip_referred_by(sip) |
Access a sip_referred_by_t from sip_t. | |
#define | SIP_REFERRED_BY_INIT() |
Initializer for structure sip_referred_by_t. | |
#define | SIPTAG_REFERRED_BY(x) |
Tag list item for pointer to a Referred-By header structure. | |
#define | SIPTAG_REFERRED_BY_REF(x) |
Tag list item for reference to a a Referred-By header pointer. | |
#define | SIPTAG_REFERRED_BY_STR(s) |
Tag list item for string with Referred-By header value. | |
#define | SIPTAG_REFERRED_BY_STR_REF(x) |
Tag list item for reference to a a Referred-By header string. | |
Typedefs | |
typedef sip_referred_by_s | sip_referred_by_t |
The structure sip_referred_by_t contains representation of Referred-By header. | |
Enumerator | |
sip_referred_by_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_referred_by_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Referred-By header. | |
SOFIAPUBFUN int | sip_referred_by_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Referred-By header. | |
sip_referred_by_t * | sip_referred_by_init (sip_referred_by_t x[1]) |
Initialize a structure sip_referred_by_t. | |
int | sip_is_referred_by (sip_header_t const *header) |
Test if header object is instance of sip_referred_by_t. | |
sip_referred_by_t * | sip_referred_by_dup (su_home_t *home, sip_referred_by_t const *hdr)) |
Duplicate (deep copy) sip_referred_by_t . | |
sip_referred_by_t * | sip_referred_by_copy (su_home_t *home, sip_referred_by_t const *hdr)) |
Copy a sip_referred_by_t header structure. | |
sip_referred_by_t * | sip_referred_by_make (su_home_t *home, char const *s)) |
Make a header structure sip_referred_by_t. | |
sip_referred_by_t * | sip_referred_by_format (su_home_t *home, char const *fmt,...))) |
Make a Referred-By header from formatting result. | |
Variables | |
tag_typedef_t | siptag_referred_by |
Tag for Referred-By header object. | |
tag_typedef_t | siptag_referred_by_str |
Tag for string with Referred-By header value. | |
msg_hclass_t | sip_referred_by_class [] |
Header class for SIP Referred-By header. |
#define SIP_REFERRED_BY_INIT | ( | ) |
Initializer for structure sip_referred_by_t.
A static sip_referred_by_t structure must be initialized. The SIP_REFERRED_BY_INIT() macro provides initialization value. For instance,
#define SIPTAG_REFERRED_BY | ( | x | ) |
Tag list item for pointer to a Referred-By header structure.
The SIPTAG_REFERRED_BY() macro is used to include a tag item with a pointer to a sip_referred_by_t object in a tag list.
x | pointer to a sip_referred_by_t header structure, or NULL. |
#define SIPTAG_REFERRED_BY_STR | ( | s | ) |
Tag list item for string with Referred-By header value.
The SIPTAG_REFERRED_BY_STR() macro is used to include a tag item with a string containing value of a sip_referred_by_t header in a tag list.
s | pointer to a string containing sip_referred_by_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_REFERRED_BY_STR_REF().
typedef struct sip_referred_by_s sip_referred_by_t |
The structure sip_referred_by_t contains representation of Referred-By header.
The sip_referred_by_t is defined as follows:
typedef struct sip_referred_by_s { sip_common_t b_common[1]; // Common fragment info sip_error_t *b_next; // Link to next (dummy) char const b_display, url_t b_url[1]; // Referrer-URI msg_param_t const *b_params; // List of parameters msg_param_t b_cid; } sip_referred_by_t;
sip_referred_by_hash |
@
Hash of Referred-By header.
int sip_is_referred_by | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_referred_by_t.
The function sip_is_referred_by() returns true (nonzero) if the header class is an instance of Referred-By header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_referred_by_t * sip_referred_by_copy | ( | su_home_t * | home, | |
sip_referred_by_t const * | hdr | |||
) | [inline] |
Copy a sip_referred_by_t header structure.
The function sip_referred_by_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 |
referred_by = sip_referred_by_copy(home, sip->sip_referred_by);
sip_referred_by_t * sip_referred_by_dup | ( | su_home_t * | home, | |
sip_referred_by_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_referred_by_t
.
The function sip_referred_by_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 |
referred_by = sip_referred_by_dup(home, sip->sip_referred_by);
sip_referred_by_t * sip_referred_by_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Referred-By header from formatting result.
The function sip_referred_by_format() makes a new Referred-By 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_referred_by_t* sip_referred_by_init | ( | sip_referred_by_t | x[1] | ) | [inline] |
Initialize a structure sip_referred_by_t.
An sip_referred_by_t structure can be initialized with the sip_referred_by_init() function/macro. For instance,
sip_referred_by_t * sip_referred_by_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_referred_by_t.
The function sip_referred_by_make() makes a new sip_referred_by_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 Referred-By header.
The header class sip_referred_by_class defines how a SIP Referred-By header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_referred_by_t header structure.