sip_tag.h

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

/**@ingroup sip_route
 * Tag list item for reference to a
 * @ref sip_route "Route header" string.
 */
#define SIPTAG_ROUTE_STR_REF(x) siptag_route_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_route_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_route_v(sip_route_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_route_vr(sip_route_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_route_v(v)   (tag_value_t)(v)
#define siptag_route_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_record_route
 *
 * Tag list item for pointer to a @ref sip_record_route "Record-Route header"
 * structure #sip_record_route_t.
 *
 * The SIPTAG_RECORD_ROUTE() macro is used to include a tag item with a
 * pointer to a #sip_record_route_t structure in a tag list.
 *
 * @param x pointer to a #sip_record_route_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_RECORD_ROUTE_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_RECORD_ROUTE(x) siptag_record_route, siptag_record_route_v(x)

SOFIAPUBVAR tag_typedef_t siptag_record_route;

/**@ingroup sip_record_route
 * Tag list item for reference to a 
 * @ref sip_record_route "Record-Route header" pointer.
 */
#define SIPTAG_RECORD_ROUTE_REF(x) siptag_record_route_ref, siptag_record_route_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_record_route_ref;

/**@ingroup sip_record_route
 *
 * Tag list item for string with @ref sip_record_route "Record-Route header" value.
 *
 * The SIPTAG_RECORD_ROUTE_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_record_route_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_record_route "Record-Route header" value, or NULL.
 *
 * The string in SIPTAG_RECORD_ROUTE_STR() can be converted to a
 * #sip_record_route_t header structure by giving the string @a s has
 * second argument to function sip_record_route_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_RECORD_ROUTE_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_RECORD_ROUTE_STR(s) siptag_record_route_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_record_route_str;

/**@ingroup sip_record_route
 * Tag list item for reference to a
 * @ref sip_record_route "Record-Route header" string.
 */
#define SIPTAG_RECORD_ROUTE_STR_REF(x) siptag_record_route_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_record_route_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_record_route_v(sip_record_route_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_record_route_vr(sip_record_route_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_record_route_v(v)   (tag_value_t)(v)
#define siptag_record_route_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_max_forwards
 *
 * Tag list item for pointer to a @ref sip_max_forwards "Max-Forwards header"
 * structure #sip_max_forwards_t.
 *
 * The SIPTAG_MAX_FORWARDS() macro is used to include a tag item with a
 * pointer to a #sip_max_forwards_t structure in a tag list.
 *
 * @param x pointer to a #sip_max_forwards_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_MAX_FORWARDS_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_MAX_FORWARDS(x) siptag_max_forwards, siptag_max_forwards_v(x)

SOFIAPUBVAR tag_typedef_t siptag_max_forwards;

/**@ingroup sip_max_forwards
 * Tag list item for reference to a 
 * @ref sip_max_forwards "Max-Forwards header" pointer.
 */
#define SIPTAG_MAX_FORWARDS_REF(x) siptag_max_forwards_ref, siptag_max_forwards_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_max_forwards_ref;

/**@ingroup sip_max_forwards
 *
 * Tag list item for string with @ref sip_max_forwards "Max-Forwards header" value.
 *
 * The SIPTAG_MAX_FORWARDS_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_max_forwards_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_max_forwards "Max-Forwards header" value, or NULL.
 *
 * The string in SIPTAG_MAX_FORWARDS_STR() can be converted to a
 * #sip_max_forwards_t header structure by giving the string @a s has
 * second argument to function sip_max_forwards_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_MAX_FORWARDS_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_MAX_FORWARDS_STR(s) siptag_max_forwards_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_max_forwards_str;

/**@ingroup sip_max_forwards
 * Tag list item for reference to a
 * @ref sip_max_forwards "Max-Forwards header" string.
 */
#define SIPTAG_MAX_FORWARDS_STR_REF(x) siptag_max_forwards_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_max_forwards_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_max_forwards_v(sip_max_forwards_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_max_forwards_vr(sip_max_forwards_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_max_forwards_v(v)   (tag_value_t)(v)
#define siptag_max_forwards_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_proxy_require
 *
 * Tag list item for pointer to a @ref sip_proxy_require "Proxy-Require header"
 * structure #sip_proxy_require_t.
 *
 * The SIPTAG_PROXY_REQUIRE() macro is used to include a tag item with a
 * pointer to a #sip_proxy_require_t structure in a tag list.
 *
 * @param x pointer to a #sip_proxy_require_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_PROXY_REQUIRE_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_PROXY_REQUIRE(x) siptag_proxy_require, siptag_proxy_require_v(x)

SOFIAPUBVAR tag_typedef_t siptag_proxy_require;

/**@ingroup sip_proxy_require
 * Tag list item for reference to a 
 * @ref sip_proxy_require "Proxy-Require header" pointer.
 */
#define SIPTAG_PROXY_REQUIRE_REF(x) siptag_proxy_require_ref, siptag_proxy_require_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_proxy_require_ref;

/**@ingroup sip_proxy_require
 *
 * Tag list item for string with @ref sip_proxy_require "Proxy-Require header" value.
 *
 * The SIPTAG_PROXY_REQUIRE_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_proxy_require_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_proxy_require "Proxy-Require header" value, or NULL.
 *
 * The string in SIPTAG_PROXY_REQUIRE_STR() can be converted to a
 * #sip_proxy_require_t header structure by giving the string @a s has
 * second argument to function sip_proxy_require_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_PROXY_REQUIRE_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_PROXY_REQUIRE_STR(s) siptag_proxy_require_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_proxy_require_str;

/**@ingroup sip_proxy_require
 * Tag list item for reference to a
 * @ref sip_proxy_require "Proxy-Require header" string.
 */
#define SIPTAG_PROXY_REQUIRE_STR_REF(x) siptag_proxy_require_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_proxy_require_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_proxy_require_v(sip_proxy_require_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_proxy_require_vr(sip_proxy_require_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_proxy_require_v(v)   (tag_value_t)(v)
#define siptag_proxy_require_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_from
 *
 * Tag list item for pointer to a @ref sip_from "From header"
 * structure #sip_from_t.
 *
 * The SIPTAG_FROM() macro is used to include a tag item with a
 * pointer to a #sip_from_t structure in a tag list.
 *
 * @param x pointer to a #sip_from_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_FROM_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_FROM(x) siptag_from, siptag_from_v(x)

SOFIAPUBVAR tag_typedef_t siptag_from;

/**@ingroup sip_from
 * Tag list item for reference to a 
 * @ref sip_from "From header" pointer.
 */
#define SIPTAG_FROM_REF(x) siptag_from_ref, siptag_from_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_from_ref;

/**@ingroup sip_from
 *
 * Tag list item for string with @ref sip_from "From header" value.
 *
 * The SIPTAG_FROM_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_from_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_from "From header" value, or NULL.
 *
 * The string in SIPTAG_FROM_STR() can be converted to a
 * #sip_from_t header structure by giving the string @a s has
 * second argument to function sip_from_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_FROM_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_FROM_STR(s) siptag_from_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_from_str;

/**@ingroup sip_from
 * Tag list item for reference to a
 * @ref sip_from "From header" string.
 */
#define SIPTAG_FROM_STR_REF(x) siptag_from_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_from_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_from_v(sip_from_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_from_vr(sip_from_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_from_v(v)   (tag_value_t)(v)
#define siptag_from_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_to
 *
 * Tag list item for pointer to a @ref sip_to "To header"
 * structure #sip_to_t.
 *
 * The SIPTAG_TO() macro is used to include a tag item with a
 * pointer to a #sip_to_t structure in a tag list.
 *
 * @param x pointer to a #sip_to_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_TO_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_TO(x) siptag_to, siptag_to_v(x)

SOFIAPUBVAR tag_typedef_t siptag_to;

/**@ingroup sip_to
 * Tag list item for reference to a 
 * @ref sip_to "To header" pointer.
 */
#define SIPTAG_TO_REF(x) siptag_to_ref, siptag_to_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_to_ref;

/**@ingroup sip_to
 *
 * Tag list item for string with @ref sip_to "To header" value.
 *
 * The SIPTAG_TO_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_to_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_to "To header" value, or NULL.
 *
 * The string in SIPTAG_TO_STR() can be converted to a
 * #sip_to_t header structure by giving the string @a s has
 * second argument to function sip_to_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_TO_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_TO_STR(s) siptag_to_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_to_str;

/**@ingroup sip_to
 * Tag list item for reference to a
 * @ref sip_to "To header" string.
 */
#define SIPTAG_TO_STR_REF(x) siptag_to_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_to_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_to_v(sip_to_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_to_vr(sip_to_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_to_v(v)   (tag_value_t)(v)
#define siptag_to_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_call_id
 *
 * Tag list item for pointer to a @ref sip_call_id "Call-ID header"
 * structure #sip_call_id_t.
 *
 * The SIPTAG_CALL_ID() macro is used to include a tag item with a
 * pointer to a #sip_call_id_t structure in a tag list.
 *
 * @param x pointer to a #sip_call_id_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_CALL_ID_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_CALL_ID(x) siptag_call_id, siptag_call_id_v(x)

SOFIAPUBVAR tag_typedef_t siptag_call_id;

/**@ingroup sip_call_id
 * Tag list item for reference to a 
 * @ref sip_call_id "Call-ID header" pointer.
 */
#define SIPTAG_CALL_ID_REF(x) siptag_call_id_ref, siptag_call_id_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_call_id_ref;

/**@ingroup sip_call_id
 *
 * Tag list item for string with @ref sip_call_id "Call-ID header" value.
 *
 * The SIPTAG_CALL_ID_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_call_id_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_call_id "Call-ID header" value, or NULL.
 *
 * The string in SIPTAG_CALL_ID_STR() can be converted to a
 * #sip_call_id_t header structure by giving the string @a s has
 * second argument to function sip_call_id_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_CALL_ID_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_CALL_ID_STR(s) siptag_call_id_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_call_id_str;

/**@ingroup sip_call_id
 * Tag list item for reference to a
 * @ref sip_call_id "Call-ID header" string.
 */
#define SIPTAG_CALL_ID_STR_REF(x) siptag_call_id_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_call_id_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_call_id_v(sip_call_id_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_call_id_vr(sip_call_id_t const **vp)
{ return (tag_value_t)vp; }