Subject Header
[SIP Headers]

Collaboration diagram for Subject Header:


Detailed Description

The Subject header provides a summary or indicates the nature of the request.

Its syntax is defined in [S10.40] as follows:

    Subject  =  ( "Subject" / "s" ) HCOLON [TEXT-UTF8-TRIM]


Defines

#define sip_subject(sip)
 Access a sip_subject_t from sip_t.
#define SIP_SUBJECT_INIT()
 Initializer for structure sip_subject_t.
#define SIPTAG_SUBJECT(x)
 Tag list item for pointer to a Subject header structure.
#define SIPTAG_SUBJECT_REF(x)
 Tag list item for reference to a a Subject header pointer.
#define SIPTAG_SUBJECT_STR(s)
 Tag list item for string with Subject header value.
#define SIPTAG_SUBJECT_STR_REF(x)
 Tag list item for reference to a a Subject header string.

Enumerator

 sip_subject_hash
 @

Hash of Subject header.


Functions

SOFIAPUBFUN int sip_subject_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a Subject header.
SOFIAPUBFUN int sip_subject_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a Subject header.
sip_subject_tsip_subject_init (sip_subject_t x[1])
 Initialize a structure sip_subject_t.
int sip_is_subject (sip_header_t const *header)
 Test if header object is instance of sip_subject_t.
sip_subject_tsip_subject_dup (su_home_t *home, sip_subject_t const *hdr))
 Duplicate (deep copy) sip_subject_t.
sip_subject_tsip_subject_copy (su_home_t *home, sip_subject_t const *hdr))
 Copy a sip_subject_t header structure.
sip_subject_tsip_subject_make (su_home_t *home, char const *s))
 Make a header structure sip_subject_t.
sip_subject_tsip_subject_format (su_home_t *home, char const *fmt,...)))
 Make a Subject header from formatting result.

Variables

tag_typedef_t siptag_subject
 Tag for Subject header object.
tag_typedef_t siptag_subject_str
 Tag for string with Subject header value.
msg_hclass_t sip_subject_class []
 Header class for SIP Subject header.


Define Documentation

 
#define SIP_SUBJECT_INIT (  ) 

Initializer for structure sip_subject_t.

A static sip_subject_t structure must be initialized. The SIP_SUBJECT_INIT() macro provides initialization value. For instance,

#define SIPTAG_SUBJECT (  ) 

Tag list item for pointer to a Subject header structure.

The SIPTAG_SUBJECT() macro is used to include a tag item with a pointer to a sip_subject_t object in a tag list.

Parameters:
x pointer to a sip_subject_t header structure, or NULL.
The corresponding tag taking reference parameter is SIPTAG_SUBJECT_REF().

#define SIPTAG_SUBJECT_STR (  ) 

Tag list item for string with Subject header value.

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

Parameters:
s pointer to a string containing sip_subject_t value, or NULL.
The string in SIPTAG_SUBJECT_STR() can be converted to a sip_subject_t header structure by giving the string s has second argument to function sip_subject_make().

The corresponding tag taking reference parameter is SIPTAG_SUBJECT_STR_REF().


Enumerator Documentation

sip_subject_hash

@

Hash of Subject header.


Function Documentation

int sip_is_subject ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_subject_t.

The function sip_is_subject() returns true (nonzero) if the header class is an instance of Subject header object and false (zero) otherwise.

Parameters:
header pointer to the header structure to be tested
Returns:
The function sip_is_subject() returns true (nonzero) if the header object is an instance of header subject and false (zero) otherwise.

sip_subject_t * sip_subject_copy ( su_home_t home,
sip_subject_t const *  hdr 
) [inline]

Copy a sip_subject_t header structure.

The function sip_subject_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 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
   subject = sip_subject_copy(home, sip->sip_subject);
Returns:
The function sip_subject_copy() returns a pointer to newly copied header structure, or NULL upon an error.

sip_subject_t * sip_subject_dup ( su_home_t home,
sip_subject_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_subject_t.

The function sip_subject_dup() duplicates 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
   subject = sip_subject_dup(home, sip->sip_subject);
Returns:
The function sip_subject_dup() returns a pointer to the newly duplicated sip_subject_t header structure, or NULL upon an error.

sip_subject_t * sip_subject_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a Subject header from formatting result.

The function sip_subject_format() makes a new Subject header 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 uses the formatting result as the header value.

Parameters:
home memory home used to allocate new header structure.
fmt string used as a printf()-style format
... argument list for format
Note:
This function is usually implemented as a macro calling msg_header_format().
Returns:
The function sip_subject_format() returns a pointer to newly makes header structure, or NULL upon an error.

sip_subject_t* sip_subject_init ( sip_subject_t  x[1]  )  [inline]

Initialize a structure sip_subject_t.

An sip_subject_t structure can be initialized with the sip_subject_init() function/macro. For instance,

sip_subject_t * sip_subject_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_subject_t.

The function sip_subject_make() makes a new sip_subject_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
Note:
This function is usually implemented as a macro calling sip_header_make().
Returns:
The function sip_subject_make() returns a pointer to newly maked sip_subject_t header structure, or NULL upon an error.


Variable Documentation

msg_hclass_t sip_subject_class[]

Header class for SIP Subject header.

The header class sip_subject_class defines how a SIP Subject header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_subject_t header structure.


Sofia-SIP 1.12.1 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.