userapps/opensource/libosip2/include/osipparser2/headers/osip_alert_info.h

   1 /*
   2   The oSIP library implements the Session Initiation Protocol (SIP -rfc2543-)
   3   Copyright (C) 2001  Aymeric MOIZARD jack@atosc.org
   4
   5   This library is free software; you can redistribute it and/or
   6   modify it under the terms of the GNU Lesser General Public
   7   License as published by the Free Software Foundation; either
   8   version 2.1 of the License, or (at your option) any later version.
   9
  10   This library is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   Lesser General Public License for more details.
  14
  15   You should have received a copy of the GNU Lesser General Public
  16   License along with this library; if not, write to the Free Software
  17   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18 */
  19
  20
  21 #ifndef _OSIP_ALERT_INFO_H_
  22 #define _OSIP_ALERT_INFO_H_
  23
  24 #include <osipparser2/headers/osip_call_info.h>
  25
  26 /**
  27  * @file osip_alert_info.h
  28  * @brief oSIP osip_alert_info header definition.
  29  */
  30
  31 /**
  32  * @defgroup oSIP_ALERT_INFO oSIP alert-info definition.
  33  * @ingroup oSIP_HEADERS
  34  * @{
  35  */
  36
  37 /**
  38  * Structure for Alert-Info headers.
  39  * @defvar osip_alert_info_t
  40  */
  41   typedef osip_call_info_t osip_alert_info_t;
  42
  43 #ifdef __cplusplus
  44 extern "C"
  45 {
  46 #endif
  47
  48 /**
  49  * Allocate a Alert-Info element.
  50  * @param header The element to work on.
  51  */
  52 #define  osip_alert_info_init(header)      osip_call_info_init(header)
  53 /**
  54  * Free a Alert-Info element.
  55  * @param header The element to work on.
  56  */
  57 #define  osip_alert_info_free(header)      osip_call_info_free(header)
  58 /**
  59  * Parse a Alert-Info element.
  60  * @param header The element to work on.
  61  * @param hvalue The string to parse.
  62  */
  63 #define  osip_alert_info_parse(header, hvalue)  osip_call_info_parse(header, hvalue)
  64 /**
  65  * Get a string representation of a Alert-Info element.
  66  * @param header The element to work on.
  67  * @param dest A pointer on the new allocated string.
  68  */
  69 #define  osip_alert_info_to_str(header,dest)   osip_call_info_to_str(header,dest)
  70 /**
  71  * Clone a Alert-Info element.
  72  * @param header The element to work on.
  73  * @param dest A pointer on the copy of the element.
  74  */
  75 #define  osip_alert_info_clone(header, dest)  osip_call_info_clone(header, dest)
  76 /**
  77  * Get uri from an Alert-Info element.
  78  * @param header The element to work on.
  79  */
  80 #define  osip_alert_info_get_uri(header)    osip_call_info_get_uri(header)
  81 /**
  82  * Set the uri of an Alert-Info element.
  83  * @param header The element to work on.
  84  * @param uri The value of the new parameter.
  85  */
  86 #define  osip_alert_info_set_uri(header, uri) osip_call_info_set_uri(header, uri)
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 /** @} */
  93
  94 #endif