userapps/opensource/libosip2/include/osipparser2/headers/osip_proxy_authenticate.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_PROXY_AUHTHENTICATE_H_
  22 #define _OSIP_PROXY_AUHTHENTICATE_H_
  23
  24 #include <osipparser2/headers/osip_www_authenticate.h>
  25
  26 /**
  27  * @file osip_proxy_authenticate.h
  28  * @brief oSIP osip_proxy_authenticate header definition.
  29  */
  30
  31 /**
  32  * @defgroup oSIP_PROXY_AUTHENTICATE oSIP proxy-authenticate header definition.
  33  * @ingroup oSIP_HEADERS
  34  * @{
  35  */
  36
  37 /**
  38  * Structure for Proxy-Authenticate headers.
  39  * @defvar osip_proxy_authenticate_t
  40  */
  41   typedef osip_www_authenticate_t osip_proxy_authenticate_t;
  42
  43 #ifdef __cplusplus
  44 extern "C"
  45 {
  46 #endif
  47
  48 /**
  49  * Allocate a Proxy-Authenticate element.
  50  * @param header The element to work on.
  51  */
  52 #define osip_proxy_authenticate_init(header)     osip_www_authenticate_init(header)
  53 /**
  54  * Parse a Proxy-Authenticate element.
  55  * @param header The element to work on.
  56  * @param hvalue The string to parse.
  57  */
  58 #define osip_proxy_authenticate_parse(header, hvalue) osip_www_authenticate_parse(header, hvalue)
  59 /**
  60  * Get a string representation of a Proxy-Authenticate element.
  61  * @param header The element to work on.
  62  * @param dest A pointer on the new allocated string.
  63  */
  64 #define osip_proxy_authenticate_to_str(header, dest) osip_www_authenticate_to_str(header, dest)
  65 /**
  66  * Free a Proxy-Authenticate element.
  67  * @param header The element to work on.
  68  */
  69 #define osip_proxy_authenticate_free(header)     osip_www_authenticate_free(header)
  70 /**
  71  * Clone a Proxy-Authenticate element.
  72  * @param header The element to work on.
  73  * @param dest A pointer on the copy of the element.
  74  */
  75 #define osip_proxy_authenticate_clone(header, dest) osip_www_authenticate_clone(header, dest)
  76
  77 /**
  78  * Get value of the auth_type parameter from a Proxy-Authenticate element.
  79  * @param header The element to work on.
  80  */
  81 #define osip_proxy_authenticate_get_auth_type(header)   osip_www_authenticate_get_auth_type(header)
  82 /**
  83  * Add the auth_type parameter from a Proxy-Authenticate element.
  84  * @param header The element to work on.
  85  * @param value The value of the new parameter.
  86  */
  87 #define osip_proxy_authenticate_set_auth_type(header,value) osip_www_authenticate_set_auth_type(header, value)
  88 /**
  89  * Get value of the realm parameter from a Proxy-Authenticate element.
  90  * @param header The element to work on.
  91  */
  92 #define osip_proxy_authenticate_get_realm(header)     osip_www_authenticate_get_realm(header)
  93 /**
  94  * Add the realm parameter from a Proxy-Authenticate element.
  95  * @param header The element to work on.
  96  * @param value The value of the new parameter.
  97  */
  98 #define osip_proxy_authenticate_set_realm(header, value)  osip_www_authenticate_set_realm(header, value)
  99 /**
 100  * Get value of the domain parameter from a Proxy-Authenticate element.
 101  * @param header The element to work on.
 102  */
 103 #define osip_proxy_authenticate_get_domain(header)    osip_www_authenticate_get_domain(header)
 104 /**
 105  * Add the domain parameter from a Proxy-Authenticate element.
 106  * @param header The element to work on.
 107  * @param value The value of the new parameter.
 108  */
 109 #define osip_proxy_authenticate_set_domain(header, value) osip_www_authenticate_set_domain(header, value)
 110 /**
 111  * Get value of the nonce parameter from a Proxy-Authenticate element.
 112  * @param header The element to work on.
 113  */
 114 #define osip_proxy_authenticate_get_nonce(header)     osip_www_authenticate_get_nonce(header)
 115 /**
 116  * Add the nonce parameter from a Proxy-Authenticate element.
 117  * @param header The element to work on.
 118  * @param value The value of the new parameter.
 119  */
 120 #define osip_proxy_authenticate_set_nonce(header, value)  osip_www_authenticate_set_nonce(header, value)
 121 /**
 122  * Get value of the opaque parameter from a Proxy-Authenticate element.
 123  * @param header The element to work on.
 124  */
 125 #define osip_proxy_authenticate_get_opaque(header)    osip_www_authenticate_get_opaque(header)
 126 /**
 127  * Add the opaque parameter from a Proxy-Authenticate element.
 128  * @param header The element to work on.
 129  * @param value The value of the new parameter.
 130  */
 131 #define osip_proxy_authenticate_set_opaque(header, value) osip_www_authenticate_set_opaque(header, value)
 132 /**
 133  * Get value of the stale parameter from a Proxy-Authenticate element.
 134  * @param header The element to work on.
 135  */
 136 #define osip_proxy_authenticate_get_stale(header)     osip_www_authenticate_get_stale(header)
 137 /**
 138  * Add the stale parameter from a Proxy-Authenticate element.
 139  * @param header The element to work on.
 140  * @param value The value of the new parameter.
 141  */
 142 #define osip_proxy_authenticate_set_stale(header, value)  osip_www_authenticate_set_stale(header, value)
 143 /**
 144  * Add a stale parameter set to "true" in a proxy-Authenticate element.
 145  * @param header The element to work on.
 146  */
 147 #define osip_proxy_authenticate_set_stale_true(header) osip_www_authenticate_set_stale(header,osip_strdup("true"))
 148 /**
 149  * Add a stale parameter set to "false" in a Proxy-Authenticate element.
 150  * @param header The element to work on.
 151  */
 152 #define osip_proxy_authenticate_set_stale_false(header) osip_www_authenticate_set_stale(header,osip_strdup("false"))
 153 /**
 154  * Get value of the algorithm parameter from a Proxy-Authenticate element.
 155  * @param header The element to work on.
 156  */
 157 #define osip_proxy_authenticate_get_algorithm(header) osip_www_authenticate_get_algorithm(header)
 158 /**
 159  * Add the algorithm parameter from a Proxy-Authenticate element.
 160  * @param header The element to work on.
 161  * @param value The value of the new parameter.
 162  */
 163 #define osip_proxy_authenticate_set_algorithm(header, value) osip_www_authenticate_set_algorithm(header, value)
 164 /**
 165  * Add the algorithm parameter set to "MD5" in a Proxy-Authenticate element.
 166  * @param header The element to work on.
 167  */
 168 #define osip_proxy_authenticate_set_algorithm_MD5(header) osip_www_authenticate_set_algorithm(header,osip_strdup("MD5"))
 169 /**
 170  * Get value of the qop_options parameter from a Proxy-Authenticate element.
 171  * @param header The element to work on.
 172  */
 173 #define osip_proxy_authenticate_get_qop_options(header) osip_www_authenticate_get_qop_options(header)
 174 /**
 175  * Add the qop_options parameter from a Proxy-Authenticate element.
 176  * @param header The element to work on.
 177  * @param value The value of the new parameter.
 178  */
 179 #define osip_proxy_authenticate_set_qop_options(header,value) osip_www_authenticate_set_qop_options(header,value)
 180
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif
 185
 186 /** @} */
 187
 188 #endif