The Referred-By header conveys the identity of the original referrer to the referred-to party. More...
The Referred-By header conveys the identity of the original referrer to the referred-to party.
Its syntax is defined in RFC 3892 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 / "-" / "!" / "%" / "*" / "_" / "+" / "'" / "`" / "~" )
The parsed Referred-By header is stored in sip_referred_by_t structure.
| #define SIP_REFERRED_BY_INIT | ( | ) |
Initializer for structure sip_referred_by_t.
A static sip_referred_by_t structure for Referred-By header must be initialized with the SIP_REFERRED_BY_INIT() macro. For instance,
sip_referred_by_t sip_referred_by = SIP_REFERRED_BY_INIT;
| #define SIPTAG_REFERRED_BY | ( | x | ) |
Tag list item for pointer to a Referred-By header structure sip_referred_by_t.
The SIPTAG_REFERRED_BY() macro is used to include a tag item with a pointer to a sip_referred_by_t structure in a tag list.
| x | pointer to a sip_referred_by_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_REFERRED_BY_REF().
| #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 Referred-By header value, or NULL. |
The string in SIPTAG_REFERRED_BY_STR() can be converted to a sip_referred_by_t header structure by giving the string s has second argument to function sip_referred_by_make().
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 char const *b_cid; } sip_referred_by_t;
| int sip_is_referred_by | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_referred_by_t.
Check if the header class is an instance of Referred-By header object and return true (nonzero), otherwise return false (zero).
| header | pointer to the header structure to be tested |
| 1 | (true) if the header is an instance of header referred_by | |
| 0 | (false) otherwise |
| sip_referred_by_t * sip_referred_by_copy | ( | su_home_t * | home, | |
| sip_referred_by_t const * | hdr | |||
| ) | [inline] |
Copy a list of Referred-By header header structures sip_referred_by_t.
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 list of header structure hdr.
| home | memory home used to allocate new structure | |
| hdr | pointer to the header structure to be copied |
When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old hdr header, including the encoding of the old header, if present.
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 a list of Referred-By header header structures sip_referred_by_t.
Duplicate 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 |
When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.
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.
Make a new sip_referred_by_t 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 parses the formatting result to the structure sip_referred_by_t.
| 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 for Referred-By header can be initialized with the sip_referred_by_init() function/macro. For instance,
sip_referred_by_t sip_referred_by; sip_referred_by_init(&sip_referred_by);
| sip_referred_by_t * sip_referred_by_make | ( | su_home_t * | home, | |
| char const * | s | |||
| ) | [inline] |
Make a Referred-By 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 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.
