userapps/opensource/libosip2/include/osipparser2/headers/osip_content_disposition.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_CONTENT_DISPOSITION_H_
  22 #define _OSIP_CONTENT_DISPOSITION_H_
  23
  24 #include <osipparser2/headers/osip_call_info.h>
  25
  26 /**
  27  * @file osip_content_disposition.h
  28  * @brief oSIP osip_content_disposition header definition.
  29  */
  30
  31 /**
  32  * @defgroup oSIP_CONTENT_DISPOSITION oSIP content-disposition definition.
  33  * @ingroup oSIP_HEADERS
  34  * @{
  35  */
  36
  37 /**
  38  * Structure for Content-Disposition headers.
  39  * @defvar osip_content_disposition_t
  40  */
  41   typedef osip_call_info_t osip_content_disposition_t;
  42
  43 #ifdef __cplusplus
  44 extern "C"
  45 {
  46 #endif
  47
  48 /**
  49  * Allocate a Content-Disposition element.
  50  * @param header The element to work on.
  51  */
  52 #define osip_content_disposition_init(header)      osip_call_info_init(header)
  53 /**
  54  * Free a Content-Disposition element.
  55  * @param header The element to work on.
  56  */
  57 #define osip_content_disposition_free(header)      osip_call_info_free(header)
  58 /**
  59  * Parse a Content-Disposition element.
  60  * @param header The element to work on.
  61  * @param hvalue The string to parse.
  62  */
  63   int osip_content_disposition_parse (osip_content_disposition_t * header,
  64                                  const char *hvalue);
  65 /**
  66  * Get a string representation of a Content-Disposition element.
  67  * @param header The element to work on.
  68  * @param dest A pointer on the new allocated string.
  69  */
  70 #define osip_content_disposition_to_str(header,dest)   osip_call_info_to_str(header,dest)
  71 /**
  72  * Clone a Content-Disposition element.
  73  * @param header The element to work on.
  74  * @param dest A pointer on the copy of the element.
  75  */
  76 #define osip_content_disposition_clone(header, dest)  osip_call_info_clone(header, dest)
  77
  78 /* type is of: "render" | "session" | "icon" | "alert" */
  79 /**
  80  * Set the type in the Content-Disposition element.
  81  * @param header The element to work on.
  82  * @param value The value of the element.
  83  */
  84 #define osip_content_disposition_set_type(header, value) osip_call_info_set_uri(header, value)
  85 /**
  86  * Get the type from a Content-Disposition header.
  87  * @param header The element to work on.
  88  */
  89 #define osip_content_disposition_get_type(header)    osip_call_info_get_uri(header)
  90
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif
  95
  96 /** @} */
  97
  98 #endif