sip_tag.h

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

SOFIAPUBVAR tag_typedef_t siptag_subject_ref;

/**@ingroup sip_subject
 *
 * Tag list item for string with @ref sip_subject "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.
 *
 * @param s pointer to a string containing 
 *    @ref sip_subject "Subject header" value, or NULL.
 *
 * The string in SIPTAG_SUBJECT_STR() can be converted to a
 * #sip_subject_t header structure by giving the string @a s has
 * second argument to function sip_subject_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_SUBJECT_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_SUBJECT_STR(s) siptag_subject_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_subject_str;

/**@ingroup sip_subject
 * Tag list item for reference to a
 * @ref sip_subject "Subject header" string.
 */
#define SIPTAG_SUBJECT_STR_REF(x) siptag_subject_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_subject_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_subject_v(sip_subject_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_subject_vr(sip_subject_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_subject_v(v)   (tag_value_t)(v)
#define siptag_subject_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_priority
 *
 * Tag list item for pointer to a @ref sip_priority "Priority header"
 * structure #sip_priority_t.
 *
 * The SIPTAG_PRIORITY() macro is used to include a tag item with a
 * pointer to a #sip_priority_t structure in a tag list.
 *
 * @param x pointer to a #sip_priority_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_PRIORITY_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_PRIORITY(x) siptag_priority, siptag_priority_v(x)

SOFIAPUBVAR tag_typedef_t siptag_priority;

/**@ingroup sip_priority
 * Tag list item for reference to a 
 * @ref sip_priority "Priority header" pointer.
 */
#define SIPTAG_PRIORITY_REF(x) siptag_priority_ref, siptag_priority_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_priority_ref;

/**@ingroup sip_priority
 *
 * Tag list item for string with @ref sip_priority "Priority header" value.
 *
 * The SIPTAG_PRIORITY_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_priority_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_priority "Priority header" value, or NULL.
 *
 * The string in SIPTAG_PRIORITY_STR() can be converted to a
 * #sip_priority_t header structure by giving the string @a s has
 * second argument to function sip_priority_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_PRIORITY_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_PRIORITY_STR(s) siptag_priority_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_priority_str;

/**@ingroup sip_priority
 * Tag list item for reference to a
 * @ref sip_priority "Priority header" string.
 */
#define SIPTAG_PRIORITY_STR_REF(x) siptag_priority_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_priority_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_priority_v(sip_priority_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_priority_vr(sip_priority_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_priority_v(v)   (tag_value_t)(v)
#define siptag_priority_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_call_info
 *
 * Tag list item for pointer to a @ref sip_call_info "Call-Info header"
 * structure #sip_call_info_t.
 *
 * The SIPTAG_CALL_INFO() macro is used to include a tag item with a
 * pointer to a #sip_call_info_t structure in a tag list.
 *
 * @param x pointer to a #sip_call_info_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_CALL_INFO_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_CALL_INFO(x) siptag_call_info, siptag_call_info_v(x)

SOFIAPUBVAR tag_typedef_t siptag_call_info;

/**@ingroup sip_call_info
 * Tag list item for reference to a 
 * @ref sip_call_info "Call-Info header" pointer.
 */
#define SIPTAG_CALL_INFO_REF(x) siptag_call_info_ref, siptag_call_info_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_call_info_ref;

/**@ingroup sip_call_info
 *
 * Tag list item for string with @ref sip_call_info "Call-Info header" value.
 *
 * The SIPTAG_CALL_INFO_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_call_info_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_call_info "Call-Info header" value, or NULL.
 *
 * The string in SIPTAG_CALL_INFO_STR() can be converted to a
 * #sip_call_info_t header structure by giving the string @a s has
 * second argument to function sip_call_info_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_CALL_INFO_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_CALL_INFO_STR(s) siptag_call_info_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_call_info_str;

/**@ingroup sip_call_info
 * Tag list item for reference to a
 * @ref sip_call_info "Call-Info header" string.
 */
#define SIPTAG_CALL_INFO_STR_REF(x) siptag_call_info_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_call_info_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_call_info_v(sip_call_info_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_call_info_vr(sip_call_info_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_call_info_v(v)   (tag_value_t)(v)
#define siptag_call_info_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_organization
 *
 * Tag list item for pointer to a @ref sip_organization "Organization header"
 * structure #sip_organization_t.
 *
 * The SIPTAG_ORGANIZATION() macro is used to include a tag item with a
 * pointer to a #sip_organization_t structure in a tag list.
 *
 * @param x pointer to a #sip_organization_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_ORGANIZATION_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_ORGANIZATION(x) siptag_organization, siptag_organization_v(x)

SOFIAPUBVAR tag_typedef_t siptag_organization;

/**@ingroup sip_organization
 * Tag list item for reference to a 
 * @ref sip_organization "Organization header" pointer.
 */
#define SIPTAG_ORGANIZATION_REF(x) siptag_organization_ref, siptag_organization_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_organization_ref;

/**@ingroup sip_organization
 *
 * Tag list item for string with @ref sip_organization "Organization header" value.
 *
 * The SIPTAG_ORGANIZATION_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_organization_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_organization "Organization header" value, or NULL.
 *
 * The string in SIPTAG_ORGANIZATION_STR() can be converted to a
 * #sip_organization_t header structure by giving the string @a s has
 * second argument to function sip_organization_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_ORGANIZATION_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_ORGANIZATION_STR(s) siptag_organization_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_organization_str;

/**@ingroup sip_organization
 * Tag list item for reference to a
 * @ref sip_organization "Organization header" string.
 */
#define SIPTAG_ORGANIZATION_STR_REF(x) siptag_organization_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_organization_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_organization_v(sip_organization_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_organization_vr(sip_organization_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_organization_v(v)   (tag_value_t)(v)
#define siptag_organization_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_server
 *
 * Tag list item for pointer to a @ref sip_server "Server header"
 * structure #sip_server_t.
 *
 * The SIPTAG_SERVER() macro is used to include a tag item with a
 * pointer to a #sip_server_t structure in a tag list.
 *
 * @param x pointer to a #sip_server_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_SERVER_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_SERVER(x) siptag_server, siptag_server_v(x)

SOFIAPUBVAR tag_typedef_t siptag_server;

/**@ingroup sip_server
 * Tag list item for reference to a 
 * @ref sip_server "Server header" pointer.
 */
#define SIPTAG_SERVER_REF(x) siptag_server_ref, siptag_server_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_server_ref;

/**@ingroup sip_server
 *
 * Tag list item for string with @ref sip_server "Server header" value.
 *
 * The SIPTAG_SERVER_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_server_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_server "Server header" value, or NULL.
 *
 * The string in SIPTAG_SERVER_STR() can be converted to a
 * #sip_server_t header structure by giving the string @a s has
 * second argument to function sip_server_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_SERVER_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_SERVER_STR(s) siptag_server_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_server_str;

/**@ingroup sip_server
 * Tag list item for reference to a
 * @ref sip_server "Server header" string.
 */
#define SIPTAG_SERVER_STR_REF(x) siptag_server_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_server_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_server_v(sip_server_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_server_vr(sip_server_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_server_v(v)   (tag_value_t)(v)
#define siptag_server_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_user_agent
 *
 * Tag list item for pointer to a @ref sip_user_agent "User-Agent header"
 * structure #sip_user_agent_t.
 *
 * The SIPTAG_USER_AGENT() macro is used to include a tag item with a
 * pointer to a #sip_user_agent_t structure in a tag list.
 *
 * @param x pointer to a #sip_user_agent_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_USER_AGENT_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_USER_AGENT(x) siptag_user_agent, siptag_user_agent_v(x)

SOFIAPUBVAR tag_typedef_t siptag_user_agent;

/**@ingroup sip_user_agent
 * Tag list item for reference to a 
 * @ref sip_user_agent "User-Agent header" pointer.
 */
#define SIPTAG_USER_AGENT_REF(x) siptag_user_agent_ref, siptag_user_agent_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_user_agent_ref;

/**@ingroup sip_user_agent
 *
 * Tag list item for string with @ref sip_user_agent "User-Agent header" value.
 *
 * The SIPTAG_USER_AGENT_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_user_agent_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_user_agent "User-Agent header" value, or NULL.
 *
 * The string in SIPTAG_USER_AGENT_STR() can be converted to a
 * #sip_user_agent_t header structure by giving the string @a s has
 * second argument to function sip_user_agent_make().
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_USER_AGENT_STR_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_USER_AGENT_STR(s) siptag_user_agent_str, tag_str_v(s)

SOFIAPUBVAR tag_typedef_t siptag_user_agent_str;

/**@ingroup sip_user_agent
 * Tag list item for reference to a
 * @ref sip_user_agent "User-Agent header" string.
 */
#define SIPTAG_USER_AGENT_STR_REF(x) siptag_user_agent_str_ref, tag_str_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_user_agent_str_ref;

#if SU_INLINE_TAG_CAST
su_inline tag_value_t
siptag_user_agent_v(sip_user_agent_t const *v)
{ return (tag_value_t)v; }
su_inline tag_value_t
siptag_user_agent_vr(sip_user_agent_t const **vp)
{ return (tag_value_t)vp; }
#else
#define siptag_user_agent_v(v)   (tag_value_t)(v)
#define siptag_user_agent_vr(vp) (tag_value_t)(vp)
#endif

/**@ingroup sip_in_reply_to
 *
 * Tag list item for pointer to a @ref sip_in_reply_to "In-Reply-To header"
 * structure #sip_in_reply_to_t.
 *
 * The SIPTAG_IN_REPLY_TO() macro is used to include a tag item with a
 * pointer to a #sip_in_reply_to_t structure in a tag list.
 *
 * @param x pointer to a #sip_in_reply_to_t structure, or NULL.
 *
 * The corresponding tag taking reference parameter is 
 * SIPTAG_IN_REPLY_TO_REF().
 *
 *
 * @HIDE
 */
#define SIPTAG_IN_REPLY_TO(x) siptag_in_reply_to, siptag_in_reply_to_v(x)

SOFIAPUBVAR tag_typedef_t siptag_in_reply_to;

/**@ingroup sip_in_reply_to
 * Tag list item for reference to a 
 * @ref sip_in_reply_to "In-Reply-To header" pointer.
 */
#define SIPTAG_IN_REPLY_TO_REF(x) siptag_in_reply_to_ref, siptag_in_reply_to_vr(&(x))
SOFIAPUBVAR tag_typedef_t siptag_in_reply_to_ref;

/**@ingroup sip_in_reply_to
 *
 * Tag list item for string with @ref sip_in_reply_to "In-Reply-To header" value.
 *
 * The SIPTAG_IN_REPLY_TO_STR() macro is used to include a tag item with a 
 * string containing value of a #sip_in_reply_to_t header in a tag list.
 *
 * @param s pointer to a string containing 
 *    @ref sip_in_reply_to "In-Reply-To header" value, or NULL.
 *
 * The string in SIPTAG_IN_REPLY_TO_STR() can be converted to a
 * #sip_in_reply_to_t header structure by giving the string @a s has
 * secon