sip 1.12.11devel
Loading...
Searching...
No Matches
Data Structures | Macros | Enumerator | Functions | Variables
Sip_security_client

Data Structures

struct  sip_security_agree_s
 Structure for Security-Client, Security-Server, and Security-Verify headers. More...
 

Macros

#define sip_security_client(sip)
 Access a SIP Security-Client header structure sip_security_client_t from sip_t.
 
#define SIP_SECURITY_CLIENT_INIT()
 Initializer for structure sip_security_client_t.
 
#define SIPTAG_SECURITY_CLIENT(x)
 Tag list item for pointer to a Security-Client header structure sip_security_client_t.
 
#define SIPTAG_SECURITY_CLIENT_REF(x)
 Tag list item for reference to a Security-Client header pointer.
 
#define SIPTAG_SECURITY_CLIENT_STR(s)
 Tag list item for string with Security-Client header value.
 
#define SIPTAG_SECURITY_CLIENT_STR_REF(x)
 Tag list item for reference to a Security-Client header string.
 

Functions

issize_t sip_security_client_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
 Parse a SIP Security-Client header.
 
issize_t sip_security_client_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
 Print a SIP Security-Client header.
 
sip_security_client_tsip_security_client_init (sip_security_client_t x[1])
 Initialize a structure sip_security_client_t.
 
int sip_is_security_client (sip_header_t const *header)
 Test if header object is instance of sip_security_client_t.
 
sip_security_client_tsip_security_client_dup (su_home_t *home, sip_security_client_t const *hdr))
 Duplicate a list of Security-Client header header structures sip_security_client_t.
 
sip_security_client_tsip_security_client_copy (su_home_t *home, sip_security_client_t const *hdr))
 Copy a list of Security-Client header header structures sip_security_client_t.
 
sip_security_client_tsip_security_client_make (su_home_t *home, char const *s))
 Make a Security-Client header structure sip_security_client_t.
 
sip_security_client_tsip_security_client_format (su_home_t *home, char const *fmt,...)))
 Make a Security-Client header from formatting result.
 

Variables

msg_hclass_t sip_security_client_class []
 Header class for Security-Client header.
 
tag_typedef_t siptag_security_client
 Tag for Security-Client header object.
 
tag_typedef_t siptag_security_client_str
 Tag for string with Security-Client header value.
 

Detailed Description

Macro Definition Documentation

◆ SIP_SECURITY_CLIENT_INIT

#define SIP_SECURITY_CLIENT_INIT ( )

Initializer for structure sip_security_client_t.

A static sip_security_client_t structure for Security-Client header must be initialized with the SIP_SECURITY_CLIENT_INIT() macro. For instance,

#define SIP_SECURITY_CLIENT_INIT()
Initializer for structure sip_security_client_t.
Definition sip_protos.h:13238
#define sip_security_client(sip)
Access a SIP Security-Client header structure sip_security_client_t from sip_t.
Definition sip_protos.h:13221
Structure for Security-Client, Security-Server, and Security-Verify headers.
Definition sip.h:774

◆ SIPTAG_SECURITY_CLIENT

#define SIPTAG_SECURITY_CLIENT (   x)

Tag list item for pointer to a Security-Client header structure sip_security_client_t.

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

Parameters
xpointer to a sip_security_client_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_SECURITY_CLIENT_REF().

◆ SIPTAG_SECURITY_CLIENT_STR

#define SIPTAG_SECURITY_CLIENT_STR (   s)

Tag list item for string with Security-Client header value.

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

Parameters
spointer to a string containing Security-Client header value, or NULL.

The string in SIPTAG_SECURITY_CLIENT_STR() can be converted to a sip_security_client_t header structure by giving the string s has second argument to function sip_security_client_make().

The corresponding tag taking reference parameter is SIPTAG_SECURITY_CLIENT_STR_REF().

Function Documentation

◆ sip_is_security_client()

int sip_is_security_client ( sip_header_t const *  header)
inline

Test if header object is instance of sip_security_client_t.

Check if the header class is an instance of Security-Client 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 security_client
0(false) otherwise

◆ sip_security_client_copy()

sip_security_client_t * sip_security_client_copy ( su_home_t home,
sip_security_client_t const *  hdr 
)
inline

Copy a list of Security-Client header header structures sip_security_client_t.

The function sip_security_client_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
security_client = sip_security_client_copy(home, sip->sip_security_client);
sip_security_client_t * sip_security_client_copy(su_home_t *home, sip_security_client_t const *hdr))
Copy a list of Security-Client header header structures sip_security_client_t.
Definition sip_protos.h:13368
Returns
A pointer to newly copied header structure, or NULL upon an error.

◆ sip_security_client_dup()

sip_security_client_t * sip_security_client_dup ( su_home_t home,
sip_security_client_t const *  hdr 
)
inline

Duplicate a list of Security-Client header header structures sip_security_client_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
security_client = sip_security_client_dup(home, sip->sip_security_client);
sip_security_client_t * sip_security_client_dup(su_home_t *home, sip_security_client_t const *hdr))
Duplicate a list of Security-Client header header structures sip_security_client_t.
Definition sip_protos.h:13325
Returns
A pointer to the newly duplicated sip_security_client_t header structure, or NULL upon an error.

◆ sip_security_client_format()

sip_security_client_t * sip_security_client_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a Security-Client header from formatting result.

Make a new sip_security_client_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_security_client_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_security_client_init()

sip_security_client_t * sip_security_client_init ( sip_security_client_t  x[1])
inline

Initialize a structure sip_security_client_t.

An sip_security_client_t structure for Security-Client header can be initialized with the sip_security_client_init() function/macro. For instance,

sip_security_client_t * sip_security_client_init(sip_security_client_t x[1])
Initialize a structure sip_security_client_t.
Definition sip_protos.h:13256

◆ sip_security_client_make()

sip_security_client_t * sip_security_client_make ( su_home_t home,
char const *  s 
)
inline

Make a Security-Client header structure sip_security_client_t.

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

Variable Documentation

◆ sip_security_client_class

msg_hclass_t sip_security_client_class[]
extern

Header class for Security-Client header.

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