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

Macros

#define sip_etag(sip)
 Access a SIP SIP-ETag header structure sip_etag_t from sip_t.
 
#define SIP_ETAG_INIT()
 Initializer for structure sip_etag_t.
 
#define SIPTAG_ETAG(x)
 Tag list item for pointer to a SIP-ETag header structure sip_etag_t.
 
#define SIPTAG_ETAG_REF(x)
 Tag list item for reference to a SIP-ETag header pointer.
 
#define SIPTAG_ETAG_STR(s)
 Tag list item for string with SIP-ETag header value.
 
#define SIPTAG_ETAG_STR_REF(x)
 Tag list item for reference to a SIP-ETag header string.
 

Functions

issize_t sip_etag_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
 Parse a SIP SIP-ETag header.
 
issize_t sip_etag_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
 Print a SIP SIP-ETag header.
 
sip_etag_tsip_etag_init (sip_etag_t x[1])
 Initialize a structure sip_etag_t.
 
int sip_is_etag (sip_header_t const *header)
 Test if header object is instance of sip_etag_t.
 
sip_etag_tsip_etag_dup (su_home_t *home, sip_etag_t const *hdr))
 Duplicate a list of SIP-ETag header header structures sip_etag_t.
 
sip_etag_tsip_etag_copy (su_home_t *home, sip_etag_t const *hdr))
 Copy a list of SIP-ETag header header structures sip_etag_t.
 
sip_etag_tsip_etag_make (su_home_t *home, char const *s))
 Make a SIP-ETag header structure sip_etag_t.
 
sip_etag_tsip_etag_format (su_home_t *home, char const *fmt,...)))
 Make a SIP-ETag header from formatting result.
 

Variables

msg_hclass_t sip_etag_class []
 Header class for SIP-ETag header.
 
tag_typedef_t siptag_etag
 Tag for SIP-ETag header object.
 
tag_typedef_t siptag_etag_str
 Tag for string with SIP-ETag header value.
 

Detailed Description

Macro Definition Documentation

◆ SIP_ETAG_INIT

#define SIP_ETAG_INIT ( )

Initializer for structure sip_etag_t.

A static sip_etag_t structure for SIP-ETag header must be initialized with the SIP_ETAG_INIT() macro. For instance,

#define sip_etag(sip)
Access a SIP SIP-ETag header structure sip_etag_t from sip_t.
Definition sip_protos.h:14173
#define SIP_ETAG_INIT()
Initializer for structure sip_etag_t.
Definition sip_protos.h:14190

◆ SIPTAG_ETAG

#define SIPTAG_ETAG (   x)

Tag list item for pointer to a SIP-ETag header structure sip_etag_t.

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

Parameters
xpointer to a sip_etag_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_ETAG_REF().

◆ SIPTAG_ETAG_STR

#define SIPTAG_ETAG_STR (   s)

Tag list item for string with SIP-ETag header value.

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

Parameters
spointer to a string containing SIP-ETag header value, or NULL.

The string in SIPTAG_ETAG_STR() can be converted to a sip_etag_t header structure by giving the string s has second argument to function sip_etag_make().

The corresponding tag taking reference parameter is SIPTAG_ETAG_STR_REF().

Function Documentation

◆ sip_etag_copy()

sip_etag_t * sip_etag_copy ( su_home_t home,
sip_etag_t const *  hdr 
)
inline

Copy a list of SIP-ETag header header structures sip_etag_t.

The function sip_etag_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
etag = sip_etag_copy(home, sip->sip_etag);
sip_etag_t * sip_etag_copy(su_home_t *home, sip_etag_t const *hdr))
Copy a list of SIP-ETag header header structures sip_etag_t.
Definition sip_protos.h:14320
Returns
A pointer to newly copied header structure, or NULL upon an error.

◆ sip_etag_dup()

sip_etag_t * sip_etag_dup ( su_home_t home,
sip_etag_t const *  hdr 
)
inline

Duplicate a list of SIP-ETag header header structures sip_etag_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
etag = sip_etag_dup(home, sip->sip_etag);
sip_etag_t * sip_etag_dup(su_home_t *home, sip_etag_t const *hdr))
Duplicate a list of SIP-ETag header header structures sip_etag_t.
Definition sip_protos.h:14277
Returns
A pointer to the newly duplicated sip_etag_t header structure, or NULL upon an error.

◆ sip_etag_format()

sip_etag_t * sip_etag_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a SIP-ETag header from formatting result.

Make a new sip_etag_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_etag_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_etag_init()

sip_etag_t * sip_etag_init ( sip_etag_t  x[1])
inline

Initialize a structure sip_etag_t.

An sip_etag_t structure for SIP-ETag header can be initialized with the sip_etag_init() function/macro. For instance,

sip_etag_t * sip_etag_init(sip_etag_t x[1])
Initialize a structure sip_etag_t.
Definition sip_protos.h:14208

◆ sip_etag_make()

sip_etag_t * sip_etag_make ( su_home_t home,
char const *  s 
)
inline

Make a SIP-ETag header structure sip_etag_t.

The function sip_etag_make() makes a new sip_etag_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_etag_t header structure, or NULL upon an error.

◆ sip_is_etag()

int sip_is_etag ( sip_header_t const *  header)
inline

Test if header object is instance of sip_etag_t.

Check if the header class is an instance of SIP-ETag 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 etag
0(false) otherwise

Variable Documentation

◆ sip_etag_class

msg_hclass_t sip_etag_class[]
extern

Header class for SIP-ETag header.

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