Accept-Contact Header
[SIP Headers]

Collaboration diagram for Accept-Contact Header:


Detailed Description

The Accept-Contact and Reject-Contact syntax is defined in draft-ietf-sip-callerprefs-07.txt section 10 as follows:.

      Accept-Contact    =  ("Accept-Contact" / "a") HCOLON ac-value
                           *(COMMA ac-value)
      Reject-Contact    =  ("Reject-Contact" / "j") HCOLON rc-value
                           *(COMMA rc-value)
      ac-value          =  "*" *(SEMI ac-params)
      rc-value          =  "*" *(SEMI rc-params)
      ac-params         =  feature-param / c-p-q / req-param
                           / explicit-param / generic-param
      rc-params         =  feature-param / req-param
                           / explicit-param / generic-param
      feature-param     =  enc-feature-tag [EQUAL LDQUOT (tag-value-list
                           / string-value ) RDQUOT]
      enc-feature-tag   =  base-tags / other-tags
      base-tags         =  "attendant" / "audio" / "automata" /
                           "class" / "duplex" / "data" /
                           "control" / "mobility" / "description" /
                           "events" / "priority" / "methods" /
                           "schemes" / "application" / "video" /
                           "msgserver" / "language" / "type" /
                           "isfocus" / "uri-user" / "uri-domain"
      other-tags        =  "+" ftag-name
      ftag-name         =  ALPHA *( ALPHA / DIGIT / "!" / ""' /
                           "." / "-" / "%" )
      tag-value-list    =  tag-value *("," tag-value)
      tag-value         =  ["!"] (token-nobang / boolean / numeric)
      token-nobang      =  1*(alphanum / "-" / "." / "%" / "*"
                           / "_" / "+" / "`" / "'" / "~" )
      boolean           =  "TRUE" / "FALSE"
      numeric           =  "#" numeric-relation number
      numeric-relation  =  ">=" / "<=" / "=" / (number ":")
      number            =  [ "+" / "-" ] 1*DIGIT ["." 0*DIGIT]
      string-value      =  "<" qdtext ">"
      req-param         =  "require"
      explicit-param    =  "explicit"

The sip_accept_contact_t or sip_reject_contact_t is defined as follows:

 typedef struct sip_caller_prefs_s
 {
   sip_common_t        cp_common[1];   // Common fragment info
   sip_caller_prefs_t *cp_next;  // Link to next
   msg_param_t const  *cp_params;      
   msg_param_t         cp_q;           // Priority
   unsigned            cp_require;
   unsigned            cp_explicit;
 } sip_accept_contact_t, sip_reject_contact_t;


Defines

#define sip_accept_contact(sip)
 Access a sip_accept_contact_t from sip_t.
#define SIP_ACCEPT_CONTACT_INIT()
 Initializer for structure sip_accept_contact_t.
#define SIPTAG_ACCEPT_CONTACT(x)
 Tag list item for pointer to a Accept-Contact header structure.
#define SIPTAG_ACCEPT_CONTACT_REF(x)
 Tag list item for reference to a a Accept-Contact header pointer.
#define SIPTAG_ACCEPT_CONTACT_STR(s)
 Tag list item for string with Accept-Contact header value.
#define SIPTAG_ACCEPT_CONTACT_STR_REF(x)
 Tag list item for reference to a a Accept-Contact header string.

Enumerator

 sip_accept_contact_hash
 @

Hash of Accept-Contact header.


Functions

SOFIAPUBFUN int sip_accept_contact_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a Accept-Contact header.
SOFIAPUBFUN int sip_accept_contact_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a Accept-Contact header.
sip_accept_contact_tsip_accept_contact_init (sip_accept_contact_t x[1])
 Initialize a structure sip_accept_contact_t.
int sip_is_accept_contact (sip_header_t const *header)
 Test if header object is instance of sip_accept_contact_t.
sip_accept_contact_tsip_accept_contact_dup (su_home_t *home, sip_accept_contact_t const *hdr))
 Duplicate (deep copy) sip_accept_contact_t.
sip_accept_contact_tsip_accept_contact_copy (su_home_t *home, sip_accept_contact_t const *hdr))
 Copy a sip_accept_contact_t header structure.
sip_accept_contact_tsip_accept_contact_make (su_home_t *home, char const *s))
 Make a header structure sip_accept_contact_t.
sip_accept_contact_tsip_accept_contact_format (su_home_t *home, char const *fmt,...)))
 Make a Accept-Contact header from formatting result.

Variables

tag_typedef_t siptag_accept_contact
 Tag for Accept-Contact header object.
tag_typedef_t siptag_accept_contact_str
 Tag for string with Accept-Contact header value.
msg_hclass_t sip_accept_contact_class []
 Header class for SIP Accept-Contact header.


Define Documentation

 
#define SIP_ACCEPT_CONTACT_INIT (  ) 

Initializer for structure sip_accept_contact_t.

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

#define SIPTAG_ACCEPT_CONTACT (  ) 

Tag list item for pointer to a Accept-Contact header structure.

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

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

#define SIPTAG_ACCEPT_CONTACT_STR (  ) 

Tag list item for string with Accept-Contact header value.

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

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

The corresponding tag taking reference parameter is SIPTAG_ACCEPT_CONTACT_STR_REF().


Enumerator Documentation

sip_accept_contact_hash

@

Hash of Accept-Contact header.


Function Documentation

sip_accept_contact_t * sip_accept_contact_copy ( su_home_t home,
sip_accept_contact_t const *  hdr 
) [inline]

Copy a sip_accept_contact_t header structure.

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

sip_accept_contact_t * sip_accept_contact_dup ( su_home_t home,
sip_accept_contact_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_accept_contact_t.

The function sip_accept_contact_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
   accept_contact = sip_accept_contact_dup(home, sip->sip_accept_contact);
Returns:
The function sip_accept_contact_dup() returns a pointer to the newly duplicated sip_accept_contact_t header structure, or NULL upon an error.

sip_accept_contact_t * sip_accept_contact_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a Accept-Contact header from formatting result.

The function sip_accept_contact_format() makes a new Accept-Contact 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_accept_contact_format() returns a pointer to newly makes header structure, or NULL upon an error.

sip_accept_contact_t* sip_accept_contact_init ( sip_accept_contact_t  x[1]  )  [inline]

Initialize a structure sip_accept_contact_t.

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

sip_accept_contact_t * sip_accept_contact_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_accept_contact_t.

The function sip_accept_contact_make() makes a new sip_accept_contact_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_accept_contact_make() returns a pointer to newly maked sip_accept_contact_t header structure, or NULL upon an error.

int sip_is_accept_contact ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_accept_contact_t.

The function sip_is_accept_contact() returns true (nonzero) if the header class is an instance of Accept-Contact header object and false (zero) otherwise.

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


Variable Documentation

msg_hclass_t sip_accept_contact_class[]

Header class for SIP Accept-Contact header.

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