sip_protos.h

Sofia SIP is an open-source SIP User-Agent library, compliant with the IETF RFC3261 specification.

 * newly duplicated #sip_route_t header structure, or NULL
 * upon an error.
 *
 */
#if SU_HAVE_INLINE
su_inline
#endif
sip_route_t *sip_route_dup(su_home_t *home, sip_route_t const *hdr) 
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
sip_route_t *sip_route_dup(su_home_t *home, sip_route_t const *hdr)
{ 
  return (sip_route_t *)
    msg_header_dup_as(home, sip_route_class, (msg_header_t const *)hdr);
}
#endif

/**Copy a list of @ref sip_route "Route header" header structures #sip_route_t.
 * 
 * The function sip_route_copy() copies a header structure @a
 * hdr.  If the header structure @a hdr contains a reference (@c
 * hdr->h_next) to a list of headers, all the headers in that
 * list are copied, too. The function uses given memory @a home
 * to allocate all the memory areas used to copy the list of header
 * structure @a hdr.
 * 
 * @param home    memory home used to allocate new structure
 * @param 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 @a hdr header, including the encoding of the
 * old header, if present.
 * 
 * @par Example
 * @code
 * 
 *   route = sip_route_copy(home, sip->sip_route);
 * 
 * @endcode
 * 
 * @return
 * A pointer to newly copied header structure, or NULL upon an error.
 *
 */
#if SU_HAVE_INLINE
su_inline
#endif
sip_route_t *sip_route_copy(su_home_t *home, sip_route_t const *hdr) 
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
sip_route_t *sip_route_copy(su_home_t *home, sip_route_t const *hdr) 
{ 
  return (sip_route_t *)
    msg_header_copy_as(home, sip_route_class, (msg_header_t const *)hdr); 
}
#endif

/**Make a @ref sip_route "Route header" structure #sip_route_t.
 * 
 * The function sip_route_make() makes a new
 * #sip_route_t header structure.  It allocates a new
 * header structure, and decodes the string @a s as the
 * value of the structure.
 * 
 * @param home memory home used to allocate new header structure.
 * @param s    string to be decoded as value of the new header structure
 * 
 * @return
 * A pointer to newly maked #sip_route_t header structure, or NULL upon an
 * error.
 *
 */
#if SU_HAVE_INLINE
su_inline 
#endif
sip_route_t *sip_route_make(su_home_t *home, char const *s)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline sip_route_t *sip_route_make(su_home_t *home, char const *s)
{
  return (sip_route_t *)sip_header_make(home, sip_route_class, s);
}
#endif

/**Make a @ref sip_route "Route header" from formatting result.
 * 
 * Make a new #sip_route_t object using formatting result as its value. 
 * The function first prints the arguments according to the format @a fmt
 * specified. Then it allocates a new header structure, and parses the
 * formatting result to the structure #sip_route_t.
 * 
 * @param home   memory home used to allocate new header structure.
 * @param fmt    string used as a printf()-style format
 * @param ...    argument list for format
 * 
 * @return
 * A pointer to newly
 * makes header structure, or NULL upon an error.
 * 
 * @HIDE
 *
 */
#if SU_HAVE_INLINE
su_inline
#endif
sip_route_t *sip_route_format(su_home_t *home, char const *fmt, ...)
     __attribute__((__malloc__, __format__ (printf, 2, 3)));

#if SU_HAVE_INLINE
su_inline sip_route_t *sip_route_format(su_home_t *home, char const *fmt, ...)
{
  sip_header_t *h;
  va_list ap;
  
  va_start(ap, fmt);
  h = sip_header_vformat(home, sip_route_class, fmt, ap);
  va_end(ap);
 
  return (sip_route_t *)h;
}
#endif

/** @} */

/**@addtogroup sip_record_route
 * @{
 */

/** Parse a SIP @ref sip_record_route "Record-Route header". @internal */
SOFIAPUBFUN issize_t sip_record_route_d(su_home_t *, msg_header_t *,
				       char *s, isize_t slen);

/** Print a SIP @ref sip_record_route "Record-Route header". @internal */
SOFIAPUBFUN issize_t sip_record_route_e(char b[], isize_t bsiz,
                    	            msg_header_t const *h, int flags);

/**Access a SIP @ref sip_record_route "Record-Route header"
 * structure #sip_record_route_t from #sip_t.
 * 
 */
#define sip_record_route(sip) \
  ((sip_record_route_t *)msg_header_access((msg_pub_t*)(sip), sip_record_route_class))

/**Initializer for structure #sip_record_route_t.
 * 
 * A static #sip_record_route_t structure for
 * @ref sip_record_route "Record-Route header" must be initialized with
 * the SIP_RECORD_ROUTE_INIT() macro. 
 * For instance,
 * @code 
 * 
 *  sip_record_route_t sip_record_route = SIP_RECORD_ROUTE_INIT;
 * 
 * @endcode
 * @HI
 *
 */
#define SIP_RECORD_ROUTE_INIT() SIP_HDR_INIT(record_route)

/**Initialize a structure #sip_record_route_t.
 * 
 * An #sip_record_route_t structure for
 * @ref sip_record_route "Record-Route header" can be initialized with the
 * sip_record_route_init() function/macro. For instance,
 * @code
 * 
 *  sip_record_route_t sip_record_route;
 * 
 *  sip_record_route_init(&sip_record_route);
 * 
 * @endcode
 * @HI
 *
 */
#if SU_HAVE_INLINE
su_inline sip_record_route_t *sip_record_route_init(sip_record_route_t x[1])
{
  return SIP_HEADER_INIT(x, sip_record_route_class, sizeof(sip_record_route_t));
}
#else
#define sip_record_route_init(x) \
  SIP_HEADER_INIT(x, sip_record_route_class, sizeof(sip_record_route_t))
#endif

/**Test if header object is instance of #sip_record_route_t.
 * 
 * Check if the header class is an instance of
 * @ref sip_record_route "Record-Route header" object and return true (nonzero),
 * otherwise return false (zero).
 * 
 * @param header pointer to the header structure to be tested
 * 
 * @retval 1 (true) if the @a header is an instance of header record_route 
 * @retval 0 (false) otherwise
 *
 */
#if SU_HAVE_INLINE
su_inline int sip_is_record_route(sip_header_t const *header)
{
  return header && header->sh_class->hc_hash == sip_record_route_hash;
}
#else
int sip_is_record_route(sip_header_t const *header);
#endif

#define sip_record_route_p(h) sip_is_record_route((h))


/**Duplicate a list of @ref sip_record_route "Record-Route header" header structures #sip_record_route_t.
 * 
 * Duplicate a header
 * structure @a hdr.  If the header structure @a hdr
 * contains a reference (@c hdr->x_next) to a list of
 * headers, all the headers in the list are duplicated, too.
 * 
 * @param home  memory home used to allocate new structure
 * @param 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 @a home to allocate all the
 * memory areas used to copy the header.
 * 
 * @par Example
 * @code
 * 
 *   record_route = sip_record_route_dup(home, sip->sip_record_route);
 * 
 * @endcode
 * 
 * @return
 * A pointer to the
 * newly duplicated #sip_record_route_t header structure, or NULL
 * upon an error.
 *
 */
#if SU_HAVE_INLINE
su_inline
#endif
sip_record_route_t *sip_record_route_dup(su_home_t *home, sip_record_route_t const *hdr) 
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
sip_record_route_t *sip_record_route_dup(su_home_t *home, sip_record_route_t const *hdr)
{ 
  return (sip_record_route_t *)
    msg_header_dup_as(home, sip_record_route_class, (msg_header_t const *)hdr);
}
#endif

/**Copy a list of @ref sip_record_route "Record-Route header" header structures #sip_record_route_t.
 * 
 * The function sip_record_route_copy() copies a header structure @a
 * hdr.  If the header structure @a hdr contains a reference (@c
 * hdr->h_next) to a list of headers, all the headers in that
 * list are copied, too. The function uses given memory @a home
 * to allocate all the memory areas used to copy the list of header
 * structure @a hdr.
 * 
 * @param home    memory home used to allocate new structure
 * @param 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 @a hdr header, including the encoding of the
 * old header, if present.
 * 
 * @par Example
 * @code
 * 
 *   record_route = sip_record_route_copy(home, sip->sip_record_route);
 * 
 * @endcode
 * 
 * @return
 * A pointer to newly copied header structure, or NULL upon an error.
 *
 */
#if SU_HAVE_INLINE
su_inline
#endif
sip_record_route_t *sip_record_route_copy(su_home_t *home, sip_record_route_t const *hdr) 
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
sip_record_route_t *sip_record_route_copy(su_home_t *home, sip_record_route_t const *hdr) 
{ 
  return (sip_record_route_t *)
    msg_header_copy_as(home, sip_record_route_class, (msg_header_t const *)hdr); 
}
#endif

/**Make a @ref sip_record_route "Record-Route header" structure #sip_record_route_t.
 * 
 * The function sip_record_route_make() makes a new
 * #sip_record_route_t header structure.  It allocates a new
 * header structure, and decodes the string @a s as the
 * value of the structure.
 * 
 * @param home memory home used to allocate new header structure.
 * @param s    string to be decoded as value of the new header structure
 * 
 * @return
 * A pointer to newly maked #sip_record_route_t header structure, or NULL upon an
 * error.
 *
 */
#if SU_HAVE_INLINE
su_inline 
#endif
sip_record_route_t *sip_record_route_make(su_home_t *home, char const *s)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline sip_record_route_t *sip_record_route_make(su_home_t *home, char const *s)
{
  return (sip_record_route_t *)sip_header_make(home, sip_record_route_class, s);
}
#endif

/**Make a @ref sip_record_route "Record-Route header" from formatting result.
 * 
 * Make a new #sip_record_route_t object using formatting result as its value. 
 * The function first prints the arguments according to the format @a fmt
 * specified. Then it allocates a new header structure, and parses the
 * formatting result to the structure #sip_record_route_t.
 * 
 * @param home   memory home used to allocate new header structure.
 * @param fmt    string used as a printf()-style format
 * @param ...    argument list for format
 * 
 * @return
 * A pointer to newly
 * makes header structure, or NULL upon an error.
 * 
 * @HIDE
 *
 */
#if SU_HAVE_INLINE
su_inline
#endif
sip_record_route_t *sip_record_route_format(su_home_t *home, char const *fmt, ...)
     __attribute__((__malloc__, __format__ (printf, 2, 3)));

#if SU_HAVE_INLINE
su_inline sip_record_route_t *sip_record_route_format(su_home_t *home, char const *fmt, ...)
{
  sip_header_t *h;
  va_list ap;
  
  va_start(ap, fmt);
  h = sip_header_vformat(home, sip_record_route_class, fmt, ap);
  va_end(ap);
 
  return (sip_record_route_t *)h;
}
#endif

/** @} */

/**@addtogroup sip_max_forwards
 * @{
 */

/** Parse a SIP @ref sip_max_forwards "Max-Forwards header". @internal */
SOFIAPUBFUN issize_t sip_max_forwards_d(su_home_t *, msg_header_t *,
				       char *s, isize_t slen);

/** Print a SIP @ref sip_max_forwards "Max-Forwards header". @internal */
SOFIAPUBFUN issize_t sip_max_forwards_e(char b[], isize_t bsiz,
                    	            msg_header_t const *h, int flags);

/**Access a SIP @ref sip_max_forwards "Max-Forwards header"
 * structure #sip_max_forwards_t from #sip_t.
 * 
 */
#define sip_max_forwards(sip) \
  ((sip_max_forwards_t *)msg_header_access((msg_pub_t*)(sip), sip_max_forwards_class))

/**Initializer for structure #sip_max_forwards_t.
 * 
 * A static #sip_max_forwards_t structure for
 * @ref sip_max_forwards "Max-Forwards header" must be initialized with
 * the SIP_MAX_FORWARDS_INIT() macro. 
 * For instance,
 * @code 
 * 
 *  sip_max_forwards_t sip_max_forwards = SIP_MAX_FORWARDS_INIT;
 * 
 * @endcode
 * @HI
 *
 */
#define SIP_MAX_FORWARDS_INIT() SIP_HDR_INIT(max_forwards)

/**Initialize a structure #sip_max_forwards_t.
 * 
 * An #sip_max_forwards_t structure for
 * @ref sip_max_forwards "Max-Forwards header" can be initialized with the
 * sip_max_forwards_init() function/macro. For instance,
 * @code
 * 
 *  sip_max_forwards_t sip_max_forwards;
 * 
 *  sip_max_forwards_init(&sip_max_forwards);
 * 
 * @endcode
 * @HI
 *
 */
#if SU_HAVE_INLINE
su_inline sip_max_forwards_t *sip_max_forwards_init(sip_max_forwards_t x[1])
{
  return SIP_HEADER_INIT(x, sip_max_forwards_class, sizeof(sip_max_forwards_t));
}
#else
#define sip_max_forwards_init(x) \
  SIP_HEADER_INIT(x, sip_max_forwards_class, sizeof(sip_max_forwards_t))
#endif

/**Test if header object is instance of #sip_max_forwards_t.
 * 
 * Check if the header class is an instance of
 * @ref sip_max_forwards "Max-Forwards header" object and return true (nonzero),
 * otherwise return false (zero).
 * 
 * @param header pointer to the header structure to be tested
 * 
 * @retval 1 (true) if the @a header is an instance of header max_forwards 
 * @retval 0 (false) otherwise
 *
 */
#if SU_HAVE_INLINE
su_inline int sip_is_max_forwards(sip_header_t const *header)
{
  return header && header->sh_class->hc_hash == sip_max_forwards_hash;
}
#else
int sip_is_max_forwards(sip_header_t const *header);
#endif

#define sip_max_forwards_p(h) sip_is_max_forwards((h))


/**Duplicate a list of @ref sip_max_forwards "Max-Forwards header" header structures #sip_max_forwards_t.
 * 
 * Duplicate a header
 * structure @a hdr.  If the header structure @a hdr
 * contains a reference (@c hdr->x_next) to a list of
 * headers, all the headers in the list are duplicated, too.
 * 
 * @param home  memory home used to allocate new structure
 * @param 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 @a home to allocate all the
 * memory areas used to copy the header.
 * 
 * @par Example