msg_protos.h

sip协议栈

/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <[e-mail]>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef MSG_PROTOS_H
/** Defined when <sofia-sip/msg_protos.h> has been included. */
#define MSG_PROTOS_H 

/**@ingroup msg_headers
 * @file sofia-sip/msg_protos.h
 *
 * Prototypes for common headers
 *
 * This file is automatically generated from <msg_mime.h> by msg_parser.awk.
 *
 * @author Pekka Pessi <[e-mail]>
 *
 * @date Created: Fri Aug 16 19:18:26 EEST 2002 ppessi
 */

#ifndef MSG_HEADER_H
#include <sofia-sip/msg_header.h>
#endif

SOFIA_BEGIN_DECLS

enum {
  msg_request_hash = -1,
  msg_status_hash = -2
};


/* Declare internal prototypes for unknown headers */

/**@addtogroup msg_unknown 
 * @{ 
 */

enum { 
  /** Hash of unknown headers. @internal */
  msg_unknown_hash = -3 
};

/** Parse a unknown headers. @internal */
MSG_DLL msg_parse_f msg_unknown_d;

/** Print a unknown headers. @internal */
MSG_DLL msg_print_f msg_unknown_e;

/**Header class for unknown headers.
 * 
 * The header class msg_unknown_class defines how a 
 * unknown headers header is parsed and printed.  It also
 * contains methods used by message parser and other functions
 * to manipulate the msg_unknown_t header structure.
 * 
 */
MSG_DLL extern msg_hclass_t msg_unknown_class[];

/**Initializer for structure msg_unknown_t.
 * 
 * A static msg_unknown_t structure must be initialized
 * with the MSG_UNKNOWN_INIT() macro. For instance,
 * @code 
 * 
 *  msg_unknown_t msg_unknown = MSG_UNKNOWN_INIT;
 * 
 * @endcode
 * @HI
 */
#define MSG_UNKNOWN_INIT() MSG_HDR_INIT(unknown)

/**Initialize a structure msg_unknown_t.
 * 
 * An msg_unknown_t structure can be initialized with the
 * msg_unknown_init() function/macro. For instance,
 * @code
 * 
 *  msg_unknown_t msg_unknown;
 * 
 *  msg_unknown_init(&msg_unknown);
 * 
 * @endcode
 * 
 * @param x pointer to msg_unknown_t structure 
 */
#if SU_HAVE_INLINE
su_inline msg_unknown_t *msg_unknown_init(msg_unknown_t x[1])
{
  return MSG_HEADER_INIT(x, msg_unknown_class, sizeof(msg_unknown_t));
}
#else
#define msg_unknown_init(x) \
  MSG_HEADER_INIT(x, msg_unknown_class, sizeof(msg_unknown_t))
#endif

/**Test if header object is instance of msg_unknown_t.
 * 
 * The function msg_is_unknown() returns true (nonzero) if
 * the header class is an instance of unknown headers
 * object and false (zero) otherwise.
 * 
 * @param header pointer to the header structure to be tested
 * 
 * @return
 * The function msg_is_unknown() returns true (nonzero) if
 * the header object is an instance of header unknown and
 * false (zero) otherwise.
 */
#if SU_HAVE_INLINE
su_inline int msg_is_unknown(msg_header_t const *header)
{
  msg_generic_t const *h = (msg_generic_t *)header;
  return h && h->g_common->h_class->hc_hash == msg_unknown_hash;
}
#else
int msg_is_unknown(msg_header_t const *header);
#endif

/**Duplicate (deep copy) @c msg_unknown_t.
 * 
 * The function msg_unknown_dup() duplicates a header structure @a
 * header. If the header structure @a header contains a reference
 * (@c header->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 header 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
 * 
 *   unknown = msg_unknown_dup(home, msg->msg_unknown);
 * 
 * @endcode
 * 
 * @return
 * The function msg_unknown_dup() returns a pointer to the
 * newly duplicated msg_unknown_t header structure, or NULL
 * upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_unknown_t *msg_unknown_dup(su_home_t *home, 
				 msg_unknown_t const *header)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
msg_unknown_t *msg_unknown_dup(su_home_t *home, 
				 msg_unknown_t const *header)
{
  return (msg_unknown_t *)
    msg_header_dup_as(home, msg_unknown_class, (msg_header_t const *)header); 
}
#endif


/**Copy a msg_unknown_t header structure.
 * 
 * The function msg_unknown_copy() copies a header structure @a
 * header. If the header structure @a header contains a reference
 * (@c header->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 header structure
 * @a header.
 * 
 * @param home    memory home used to allocate new structure
 * @param header  pointer to the header structure to be duplicated
 * 
 * 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 header,
 * including the encoding of the old header, if present.
 * 
 * @par Example
 * @code
 * 
 *   unknown = msg_unknown_copy(home, msg->msg_unknown);
 * 
 * @endcode
 * 
 * @return
 * The function msg_unknown_copy() returns a pointer to
 * newly copied header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_unknown_t *msg_unknown_copy(su_home_t *home, 
				  msg_unknown_t const *header)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
msg_unknown_t *msg_unknown_copy(su_home_t *home, 
				  msg_unknown_t const *header)
{
  return (msg_unknown_t *)
    msg_header_copy_as(home, msg_unknown_class, (msg_header_t const *)header); 
}
#endif

/**Make a header structure msg_unknown_t.
 * 
 * The function msg_unknown_make() makes a new
 * msg_unknown_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
 * 
 * @note This function is usually implemented as a macro calling
 * msg_header_make().
 * 
 * @return
 * The function msg_unknown_make() returns a pointer to
 * newly maked msg_unknown_t header structure, or NULL upon
 * an error.
 */
#if SU_HAVE_INLINE
su_inline msg_unknown_t *msg_unknown_make(su_home_t *home, char const *s)
{
  return (msg_unknown_t*)msg_header_make(home, msg_unknown_class, s);
}
#else
msg_unknown_t *msg_unknown_make(su_home_t *home, char const *s)
     __attribute__((__malloc__));
#endif

/**Make a unknown headers from formatting result.
 * 
 * The function msg_unknown_format() makes a new
 * unknown headers 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 uses the formatting result as the header
 * value.
 * 
 * @param home   memory home used to allocate new header structure.
 * @param fmt    string used as a printf()-style format
 * @param ...    argument list for format
 * 
 * @note This function is usually implemented as a macro calling
 * msg_header_format().
 * 
 * @return
 * The function msg_unknown_format() returns a pointer to newly
 * makes header structure, or NULL upon an error.
 * 
 * @HIDE
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_unknown_t *msg_unknown_format(su_home_t *home, char const *fmt, ...)
     __attribute__((__malloc__, __format__ (printf, 2, 3)));

#if SU_HAVE_INLINE
su_inline msg_unknown_t *msg_unknown_format(su_home_t *home, char const *fmt, ...)
{
  msg_header_t *h;
  va_list ap;
  
  va_start(ap, fmt);
  h = msg_header_vformat(home, msg_unknown_class, fmt, ap);
  va_end(ap);
 
  return (msg_unknown_t*)h;
}
#endif

/** @} */

/* Declare internal prototypes for erroneous headers */

/**@addtogroup msg_error 
 * @{ 
 */

enum { 
  /** Hash of erroneous headers. @internal */
  msg_error_hash = -4 
};

/** Parse a erroneous headers. @internal */
MSG_DLL msg_parse_f msg_error_d;

/** Print a erroneous headers. @internal */
MSG_DLL msg_print_f msg_error_e;

/**Header class for erroneous headers.
 * 
 * The header class msg_error_class defines how a 
 * erroneous headers header is parsed and printed.  It also
 * contains methods used by message parser and other functions
 * to manipulate the msg_error_t header structure.
 * 
 */
MSG_DLL extern msg_hclass_t msg_error_class[];

/**Initializer for structure msg_error_t.
 * 
 * A static msg_error_t structure must be initialized
 * with the MSG_ERROR_INIT() macro. For instance,
 * @code 
 * 
 *  msg_error_t msg_error = MSG_ERROR_INIT;
 * 
 * @endcode
 * @HI
 */
#define MSG_ERROR_INIT() MSG_HDR_INIT(error)

/**Initialize a structure msg_error_t.
 * 
 * An msg_error_t structure can be initialized with the
 * msg_error_init() function/macro. For instance,
 * @code
 * 
 *  msg_error_t msg_error;
 * 
 *  msg_error_init(&msg_error);
 * 
 * @endcode
 * 
 * @param x pointer to msg_error_t structure 
 */
#if SU_HAVE_INLINE
su_inline msg_error_t *msg_error_init(msg_error_t x[1])
{
  return MSG_HEADER_INIT(x, msg_error_class, sizeof(msg_error_t));
}
#else
#define msg_error_init(x) \
  MSG_HEADER_INIT(x, msg_error_class, sizeof(msg_error_t))
#endif

/**Test if header object is instance of msg_error_t.
 * 
 * The function msg_is_error() returns true (nonzero) if
 * the header class is an instance of erroneous headers
 * object and false (zero) otherwise.
 * 
 * @param header pointer to the header structure to be tested
 * 
 * @return
 * The function msg_is_error() returns true (nonzero) if
 * the header object is an instance of header error and
 * false (zero) otherwise.
 */
#if SU_HAVE_INLINE
su_inline int msg_is_error(msg_header_t const *header)
{
  msg_generic_t const *h = (msg_generic_t *)header;
  return h && h->g_common->h_class->hc_hash == msg_error_hash;
}
#else
int msg_is_error(msg_header_t const *header);
#endif

/**Duplicate (deep copy) @c msg_error_t.
 * 
 * The function msg_error_dup() duplicates a header structure @a
 * header. If the header structure @a header contains a reference
 * (@c header->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 header 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
 * 
 *   error = msg_error_dup(home, msg->msg_error);
 * 
 * @endcode
 * 
 * @return
 * The function msg_error_dup() returns a pointer to the
 * newly duplicated msg_error_t header structure, or NULL
 * upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_error_t *msg_error_dup(su_home_t *home, 
				 msg_error_t const *header)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
msg_error_t *msg_error_dup(su_home_t *home, 
				 msg_error_t const *header)
{
  return (msg_error_t *)
    msg_header_dup_as(home, msg_error_class, (msg_header_t const *)header); 
}
#endif


/**Copy a msg_error_t header structure.
 * 
 * The function msg_error_copy() copies a header structure @a
 * header. If the header structure @a header contains a reference
 * (@c header->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 header structure
 * @a header.
 * 
 * @param home    memory home used to allocate new structure
 * @param header  pointer to the header structure to be duplicated
 * 
 * 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 header,
 * including the encoding of the old header, if present.
 * 
 * @par Example
 * @code
 * 
 *   error = msg_error_copy(home, msg->msg_error);
 * 
 * @endcode
 * 
 * @return
 * The function msg_error_copy() returns a pointer to
 * newly copied header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_error_t *msg_error_copy(su_home_t *home, 
				  msg_error_t const *header)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
msg_error_t *msg_error_copy(su_home_t *home, 
				  msg_error_t const *header)
{
  return (msg_error_t *)
    msg_header_copy_as(home, msg_error_class, (msg_header_t const *)header); 
}
#endif

/**Make a header structure msg_error_t.
 * 
 * The function msg_error_make() makes a new
 * msg_error_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
 * 
 * @note This function is usually implemented as a macro calling
 * msg_header_make().
 * 
 * @return
 * The function msg_error_make() returns a pointer to
 * newly maked msg_error_t header structure, or NULL upon
 * an error.
 */
#if SU_HAVE_INLINE
su_inline msg_error_t *msg_error_make(su_home_t *home, char const *s)
{
  return (msg_error_t*)msg_header_make(home, msg_error_class, s);
}
#else
msg_error_t *msg_error_make(su_home_t *home, char const *s)
     __attribute__((__malloc__));
#endif

/**Make a erroneous headers from formatting result.
 * 
 * The function msg_error_format() makes a new
 * erroneous headers 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 uses the formatting result as the header
 * value.
 * 
 * @param home   memory home used to allocate new header structure.
 * @param fmt    string used as a printf()-style format
 * @param ...    argument list for format
 * 
 * @note This function is usually implemented as a macro calling
 * msg_header_format().
 * 
 * @return
 * The function msg_error_format() returns a pointer to newly
 * makes header structure, or NULL upon an error.
 * 
 * @HIDE