include/service-adapter/network-binder/na_binder.h

   1 /*
   2  * oma-ds-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 /**
  19  *   @NA_Binder.h
  20  *   @version                                                                   0.1
  21  *   @brief                                                                             This file is the header file of interface of NA Binder
  22  */
  23
  24 #ifndef NA_BINDER_H_
  25 #define NA_BINDER_H_
  26
  27 #include <sync_agent.h>
  28 #include "service-adapter/sa_define.h"
  29
  30 /**
  31  * @par Description: API to header binding for HTTP protocol
  32  *
  33  *
  34  * @par Purpose:
  35  * @par Typical use case:
  36  * @par Method of function operation:
  37  * @par Important notes:
  38  * @param[in]           string type, access type(http, obex...)
  39  * @param[in]           string type, target uri
  40  * @param[in]           boolean type, xml or wbxml
  41  * @param[out]          GList type, list of header info
  42  *
  43  * @return                              1 on success
  44  *                                                      0 on error
  45  *
  46  * @par Errors:
  47  *
  48  * @pre None.
  49  * @post
  50  * @see
  51  * @remarks None.
  52  *
  53  * @par Sample Code:
  54  * @code
  55  * @endcode
  56  */
  57 int na_http_header_binder(char *acc_type, char *loc_uri, bool is_xml, char *jsession_id, GList ** list);
  58
  59 /**
  60  * @par Description: API to free sync_agent_na_common_header_info_s structure
  61  *
  62  *
  63  * @par Purpose:
  64  * @par Typical use case:
  65  * @par Method of function operation:
  66  * @par Important notes:
  67  * @param[in]           sync_agent_na_common_header_info_s structure
  68  * @param[out]
  69  *
  70  * @return
  71  *
  72  * @par Errors:
  73  *
  74  * @pre None.
  75  * @post
  76  * @see
  77  * @remarks None.
  78  *
  79  * @par Sample Code:
  80  * @code
  81  * @endcode
  82  */
  83 void free_header_info(sync_agent_na_common_header_info_s * common_header_info);
  84
  85 #endif                          /* NA_BINDER_H_ */