doc/http_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_NETWORK_HTTP_DOC_H__
  19 #define __TIZEN_NETWORK_HTTP_DOC_H__
  20
  21 /**
  22  * @defgroup CAPI_NETWORK_HTTP_MODULE  HTTP
  23  * @brief The HTTP API provides functions for communication with server according to HTTP protocol.
  24  * @ingroup CAPI_NETWORK_FRAMEWORK
  25  *
  26  * @section CAPI_NETWORK_HTTP_MODULE_HEADER Required Header
  27  *   \#include <http.h>
  28  *
  29  * @section CAPI_NETWORK_HTTP_MODULE Overview
  30  * The HTTP API provides functions for communication with server according to HTTP protocol.
  31  * Using the HTTP APIs, you can implement features that allow the users of your application to:
  32  * - Manage HTTP session
  33  * - Manage HTTP transaction
  34  * - Send/Recieve HTTP request/response
  35  *
  36  * @if WEARABLE
  37  * @section CAPI_NETWORK_HTTP_MODULE_FEATURE Related Features
  38  * This API is related with the following features:\n
  39  * - http://tizen.org/feature/network.internet \n
  40  *
  41  * It is recommended to design feature related codes in your application for reliability.\n
  42  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  43  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  44  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
  45  *
  46  * @endif
  47  */
  48
  49 /**
  50  * @defgroup CAPI_NETWORK_HTTP_SESSION_MODULE  HTTP Session
  51  * @brief The HTTP Session API provides functions for managing HTTP session.
  52  * @ingroup CAPI_NETWORK_HTTP_MODULE
  53  *
  54  * @section CAPI_NETWORK_HTTP_SESSION_MODULE_HEADER Required Header
  55  *   \#include <http.h>
  56  *
  57  * @section CAPI_NETWORK_HTTP_SESSION_MODULE_OVERVEW Overview
  58  * The HTTP Session API provides functions for managing HTTP session.
  59  * Using the HTTP Session, you can implement features that allow the users of your application to:
  60  * - Create / Delete HTTP session
  61  * - Get activated transaction count
  62  * - Manage redirection
  63  *
  64  * @if WEARABLE
  65  * @section CAPI_NETWORK_HTTP_SESSION_MODULE_MODULE_FEATURE Related Features
  66  * This API is related with the following features:\n
  67  * - http://tizen.org/feature/network.internet \n
  68  *
  69  * It is recommended to design feature related codes in your application for reliability.\n
  70  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  71  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  72  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
  73  * @endif
  74  */
  75
  76 /**
  77  * @defgroup CAPI_NETWORK_HTTP_TRANSACTION_MODULE  HTTP Transaction
  78  * @brief The HTTP Transaction API provides functions for managing HTTP transactions.
  79  * @ingroup CAPI_NETWORK_HTTP_SESSION_MODULE
  80  *
  81  * @section CAPI_NETWORK_HTTP_TRANSACTION_MODULE_HEADER Required Header
  82  *   \#include <http.h>
  83  *
  84  * @section CAPI_NETWORK_HTTP_TRANSACTION_MODULE_OVERVIEW Overview
  85  * It allows managing HTTP transactions.
  86  * Using the HTTP Transaction, you can implement features that allow the users of your application to:
  87  * - Open/Close transactions
  88  * - Pause/Resume transactions
  89  * - Transfer HTTP request
  90  * - Get/Set transaction options such as interface, verification and timeout
  91  *
  92  * @if WEARABLE
  93  * @section CAPI_NETWORK_HTTP_TRANSACTION_MODULE_FEATURE Related Features
  94  * This API is related with the following features:\n
  95  * - http://tizen.org/feature/network.internet \n
  96  *
  97  * It is recommended to design feature related codes in your application for reliability.\n
  98  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  99  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 100  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
 101  * @endif
 102  */
 103
 104 /**
 105  * @defgroup CAPI_NETWORK_HTTP_REQUEST_MODULE  HTTP Request
 106  * @brief It manages HTTP request.
 107  * @ingroup CAPI_NETWORK_HTTP_TRANSACTION_MODULE
 108  *
 109  * @section CAPI_NETWORK_HTTP_REQUEST_MODULE_HEADER  Required Header
 110  *   \#include <http.h>
 111  *
 112  * @section CAPI_NETWORK_HTTP_REQUEST_MODULE_OVERVIEW Overview
 113  * It manages HTTP request message.
 114  * - Set/Get uri, method
 115  * - Make body for POST/PUT Method
 116  * It supports other request options according to the HTTP protocol.
 117  *
 118  * @if WEARABLE
 119  * @section CAPI_NETWORK_HTTP_REQUEST_MODULE_FEATURE Related Features
 120  * This API is related with the following features:\n
 121  * - http://tizen.org/feature/network.internet\n
 122  *
 123  * It is recommended to design feature related codes in your application for reliability.\n
 124  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 125  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 126  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
 127  * @endif
 128  */
 129
 130 /**
 131  * @defgroup CAPI_NETWORK_HTTP_RESPONSE_MODULE  HTTP Response
 132  * @brief It manages HTTP response.
 133  * @ingroup CAPI_NETWORK_HTTP_TRANSACTION_MODULE
 134  *
 135  * @section CAPI_NETWORK_HTTP_RESPONSE_MODULE_HEADER  Required Header
 136  *   \#include <http.h>
 137  *
 138  * @section CAPI_NETWORK_HTTP_RESPONSE_MODULE_OVERVIEW Overview
 139  * It manages HTTP response message.
 140  * - Get status code and reason phrase from response message
 141  *
 142  * @if WEARABLE
 143  * @section CAPI_NETWORK_HTTP_RESPONSE_MODULE_FEATURE Related Features
 144  * This API is related with the following features:\n
 145  * - http://tizen.org/feature/network.internet \n
 146  *
 147  * It is recommended to design feature related codes in your application for reliability.\n
 148  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 149  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 150  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
 151  * @endif
 152  */
 153
 154 /**
 155  * @defgroup CAPI_NETWORK_HTTP_HEADER_MODULE  HTTP Header
 156  * @brief It manages custom header
 157  * @ingroup CAPI_NETWORK_HTTP_TRANSACTION_MODULE
 158  *
 159  * @section CAPI_NETWORK_HTTP_HEADER_MODULE_HEADER  Required Header
 160  *   \#include <http.h>
 161  *
 162  * @section CAPI_NETWORK_HTTP_HEADER_MODULE_OVERVIEW Overview
 163  * It manages custom header
 164  *
 165  * @if WEARABLE
 166  * @section CAPI_NETWORK_HTTP_HEADER_MODULE_FEATURE Related Features
 167  * This API is related with the following features:\n
 168  * - http://tizen.org/feature/network.internet \n
 169  *
 170  * It is recommended to design feature related codes in your application for reliability.\n
 171  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 172  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 173  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
 174  * @endif
 175  */
 176
 177 /**
 178  * @defgroup CAPI_NETWORK_HTTP_AUTHENTICATION_MODULE  HTTP Authentication
 179  * @brief It manages HTTP Autehntication and credential
 180  * @ingroup CAPI_NETWORK_HTTP_TRANSACTION_MODULE
 181  *
 182  * @section CAPI_NETWORK_HTTP_AUTHENTICATION_MODULE_HEADER  Required Header
 183  *   \#include <http.h>
 184  *
 185  * @section CAPI_NETWORK_HTTP_AUTHENTICATION_MODULE_OVERVIEW Overview
 186  * It manages HTTP Autehntication and credential
 187  *
 188  * @if WEARABLE
 189  * @section CAPI_NETWORK_HTTP_HEADER_MODULE_FEATURE Related Features
 190  * This API is related with the following features:\n
 191  * - http://tizen.org/feature/network.internet \n
 192  *
 193  * It is recommended to design feature related codes in your application for reliability.\n
 194  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 195  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 196  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
 197  * @endif
 198  */
 199
 200 #endif /* __TIZEN_NETWORK_HTTP_DOC_H__ */