sip 1.12.11devel
Loading...
Searching...
No Matches
Macros | Enumerator | Functions | Variables
Sip_service_route

Macros

#define sip_service_route(sip)
 Access a SIP Service-Route header structure sip_service_route_t from sip_t.
 
#define SIP_SERVICE_ROUTE_INIT()
 Initializer for structure sip_service_route_t.
 
#define SIPTAG_SERVICE_ROUTE(x)
 Tag list item for pointer to a Service-Route header structure sip_service_route_t.
 
#define SIPTAG_SERVICE_ROUTE_REF(x)
 Tag list item for reference to a Service-Route header pointer.
 
#define SIPTAG_SERVICE_ROUTE_STR(s)
 Tag list item for string with Service-Route header value.
 
#define SIPTAG_SERVICE_ROUTE_STR_REF(x)
 Tag list item for reference to a Service-Route header string.
 

Functions

issize_t sip_service_route_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
 Parse a SIP Service-Route header.
 
issize_t sip_service_route_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
 Print a SIP Service-Route header.
 
sip_service_route_tsip_service_route_init (sip_service_route_t x[1])
 Initialize a structure sip_service_route_t.
 
int sip_is_service_route (sip_header_t const *header)
 Test if header object is instance of sip_service_route_t.
 
sip_service_route_tsip_service_route_dup (su_home_t *home, sip_service_route_t const *hdr))
 Duplicate a list of Service-Route header header structures sip_service_route_t.
 
sip_service_route_tsip_service_route_copy (su_home_t *home, sip_service_route_t const *hdr))
 Copy a list of Service-Route header header structures sip_service_route_t.
 
sip_service_route_tsip_service_route_make (su_home_t *home, char const *s))
 Make a Service-Route header structure sip_service_route_t.
 
sip_service_route_tsip_service_route_format (su_home_t *home, char const *fmt,...)))
 Make a Service-Route header from formatting result.
 

Variables

msg_hclass_t sip_service_route_class []
 Header class for Service-Route header.
 
tag_typedef_t siptag_service_route
 Tag for Service-Route header object.
 
tag_typedef_t siptag_service_route_str
 Tag for string with Service-Route header value.
 

Detailed Description

Macro Definition Documentation

◆ SIP_SERVICE_ROUTE_INIT

#define SIP_SERVICE_ROUTE_INIT ( )

Initializer for structure sip_service_route_t.

A static sip_service_route_t structure for Service-Route header must be initialized with the SIP_SERVICE_ROUTE_INIT() macro. For instance,

#define sip_service_route(sip)
Access a SIP Service-Route header structure sip_service_route_t from sip_t.
Definition sip_protos.h:12745
#define SIP_SERVICE_ROUTE_INIT()
Initializer for structure sip_service_route_t.
Definition sip_protos.h:12762
Structure for Route and Record-Route header fields.
Definition sip.h:681

◆ SIPTAG_SERVICE_ROUTE

#define SIPTAG_SERVICE_ROUTE (   x)

Tag list item for pointer to a Service-Route header structure sip_service_route_t.

The SIPTAG_SERVICE_ROUTE() macro is used to include a tag item with a pointer to a sip_service_route_t structure in a tag list.

Parameters
xpointer to a sip_service_route_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_SERVICE_ROUTE_REF().

◆ SIPTAG_SERVICE_ROUTE_STR

#define SIPTAG_SERVICE_ROUTE_STR (   s)

Tag list item for string with Service-Route header value.

The SIPTAG_SERVICE_ROUTE_STR() macro is used to include a tag item with a string containing value of a sip_service_route_t header in a tag list.

Parameters
spointer to a string containing Service-Route header value, or NULL.

The string in SIPTAG_SERVICE_ROUTE_STR() can be converted to a sip_service_route_t header structure by giving the string s has second argument to function sip_service_route_make().

The corresponding tag taking reference parameter is SIPTAG_SERVICE_ROUTE_STR_REF().

Function Documentation

◆ sip_is_service_route()

int sip_is_service_route ( sip_header_t const *  header)
inline

Test if header object is instance of sip_service_route_t.

Check if the header class is an instance of Service-Route header object and return true (nonzero), otherwise return false (zero).

Parameters
headerpointer to the header structure to be tested
Return values
1(true) if the header is an instance of header service_route
0(false) otherwise

◆ sip_service_route_copy()

sip_service_route_t * sip_service_route_copy ( su_home_t home,
sip_service_route_t const *  hdr 
)
inline

Copy a list of Service-Route header header structures sip_service_route_t.

The function sip_service_route_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
homememory home used to allocate new structure
hdrpointer 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
service_route = sip_service_route_copy(home, sip->sip_service_route);
sip_service_route_t * sip_service_route_copy(su_home_t *home, sip_service_route_t const *hdr))
Copy a list of Service-Route header header structures sip_service_route_t.
Definition sip_protos.h:12892
Returns
A pointer to newly copied header structure, or NULL upon an error.

◆ sip_service_route_dup()

sip_service_route_t * sip_service_route_dup ( su_home_t home,
sip_service_route_t const *  hdr 
)
inline

Duplicate a list of Service-Route header header structures sip_service_route_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
homememory home used to allocate new structure
hdrheader 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
service_route = sip_service_route_dup(home, sip->sip_service_route);
sip_service_route_t * sip_service_route_dup(su_home_t *home, sip_service_route_t const *hdr))
Duplicate a list of Service-Route header header structures sip_service_route_t.
Definition sip_protos.h:12849
Returns
A pointer to the newly duplicated sip_service_route_t header structure, or NULL upon an error.

◆ sip_service_route_format()

sip_service_route_t * sip_service_route_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a Service-Route header from formatting result.

Make a new sip_service_route_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_service_route_t.

Parameters
homememory home used to allocate new header structure.
fmtstring used as a printf()-style format
...argument list for format
Returns
A pointer to newly makes header structure, or NULL upon an error.

◆ sip_service_route_init()

sip_service_route_t * sip_service_route_init ( sip_service_route_t  x[1])
inline

Initialize a structure sip_service_route_t.

An sip_service_route_t structure for Service-Route header can be initialized with the sip_service_route_init() function/macro. For instance,

sip_service_route_t * sip_service_route_init(sip_service_route_t x[1])
Initialize a structure sip_service_route_t.
Definition sip_protos.h:12780

◆ sip_service_route_make()

sip_service_route_t * sip_service_route_make ( su_home_t home,
char const *  s 
)
inline

Make a Service-Route header structure sip_service_route_t.

The function sip_service_route_make() makes a new sip_service_route_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters
homememory home used to allocate new header structure.
sstring to be decoded as value of the new header structure
Returns
A pointer to newly maked sip_service_route_t header structure, or NULL upon an error.

Variable Documentation

◆ sip_service_route_class

msg_hclass_t sip_service_route_class[]
extern

Header class for Service-Route header.

The header class sip_service_route_class defines how a SIP Service-Route header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_service_route_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.