Loading...
Searching...
No Matches
|
issize_t | sip_rseq_d (su_home_t *, msg_header_t *, char *s, isize_t slen) |
| Parse a SIP RSeq header.
|
|
issize_t | sip_rseq_e (char b[], isize_t bsiz, msg_header_t const *h, int flags) |
| Print a SIP RSeq header.
|
|
sip_rseq_t * | sip_rseq_init (sip_rseq_t x[1]) |
| Initialize a structure sip_rseq_t.
|
|
int | sip_is_rseq (sip_header_t const *header) |
| Test if header object is instance of sip_rseq_t.
|
|
sip_rseq_t * | sip_rseq_dup (su_home_t *home, sip_rseq_t const *hdr)) |
| Duplicate a list of RSeq header header structures sip_rseq_t.
|
|
sip_rseq_t * | sip_rseq_copy (su_home_t *home, sip_rseq_t const *hdr)) |
| Copy a list of RSeq header header structures sip_rseq_t.
|
|
sip_rseq_t * | sip_rseq_make (su_home_t *home, char const *s)) |
| Make a RSeq header structure sip_rseq_t.
|
|
sip_rseq_t * | sip_rseq_format (su_home_t *home, char const *fmt,...))) |
| Make a RSeq header from formatting result.
|
|
◆ SIP_RSEQ_INIT
#define SIP_RSEQ_INIT |
( |
| ) |
|
Initializer for structure sip_rseq_t.
A static sip_rseq_t structure for RSeq header must be initialized with the SIP_RSEQ_INIT() macro. For instance,
#define sip_rseq(sip)
Access a SIP RSeq header structure sip_rseq_t from sip_t.
Definition sip_protos.h:2987
#define SIP_RSEQ_INIT()
Initializer for structure sip_rseq_t.
Definition sip_protos.h:3004
Structure for RSeq header.
Definition sip.h:693
◆ SIPTAG_RSEQ
◆ SIPTAG_RSEQ_STR
#define SIPTAG_RSEQ_STR |
( |
| s | ) |
|
◆ sip_rseq_t
@
The RSeq header identifies provisional responses within a transaction. Its syntax is defined in RFC 3262 section 10 as follows:
RSeq = "RSeq" HCOLON response-num
The parsed RSeq header is stored in sip_rseq_t structure.
The structure sip_rseq_t contains representation of an RSeq header.
The sip_rseq_t is defined as follows:
{
struct sip_rseq_s sip_rseq_t
@
Definition sip.h:188
unsigned long rs_response
Sequence number of response.
Definition sip.h:696
sip_common_t rs_common[1]
Common fragment info.
Definition sip.h:694
sip_error_t * rs_next
Dummy link to next.
Definition sip.h:695
◆ sip_is_rseq()
Test if header object is instance of sip_rseq_t.
Check if the header class is an instance of RSeq header object and return true (nonzero), otherwise return false (zero).
- Parameters
-
header | pointer to the header structure to be tested |
- Return values
-
1 | (true) if the header is an instance of header rseq |
0 | (false) otherwise |
◆ sip_rseq_copy()
Copy a list of RSeq header header structures sip_rseq_t.
The function sip_rseq_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.
- Parameters
-
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.
- Example
sip_rseq_t * sip_rseq_copy(su_home_t *home, sip_rseq_t const *hdr))
Copy a list of RSeq header header structures sip_rseq_t.
Definition sip_protos.h:3134
- Returns
- A pointer to newly copied header structure, or NULL upon an error.
◆ sip_rseq_dup()
Duplicate a list of RSeq header header structures sip_rseq_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.
- Parameters
-
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.
- Example
sip_rseq_t * sip_rseq_dup(su_home_t *home, sip_rseq_t const *hdr))
Duplicate a list of RSeq header header structures sip_rseq_t.
Definition sip_protos.h:3091
- Returns
- A pointer to the newly duplicated sip_rseq_t header structure, or NULL upon an error.
◆ sip_rseq_format()
Make a RSeq header from formatting result.
Make a new sip_rseq_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_rseq_t.
- Parameters
-
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
- Returns
- A pointer to newly makes header structure, or NULL upon an error.
◆ sip_rseq_init()
Initialize a structure sip_rseq_t.
An sip_rseq_t structure for RSeq header can be initialized with the sip_rseq_init() function/macro. For instance,
sip_rseq_t * sip_rseq_init(sip_rseq_t x[1])
Initialize a structure sip_rseq_t.
Definition sip_protos.h:3022
◆ sip_rseq_make()
Make a RSeq header structure sip_rseq_t.
The function sip_rseq_make() makes a new sip_rseq_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.
- Parameters
-
home | memory home used to allocate new header structure. |
s | string to be decoded as value of the new header structure |
- Returns
- A pointer to newly maked sip_rseq_t header structure, or NULL upon an error.
◆ sip_rseq_class
Header class for RSeq header.
The header class sip_rseq_class defines how a SIP RSeq header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_rseq_t header structure.
Sofia-SIP 1.12.11devel -
Copyright (C) 2006 Nokia Corporation. All rights reserved.
Licensed under the terms of the GNU Lesser General Public License.