resource/csdk/connectivity/inc/caedradapter.h

   1 /******************************************************************
   2  *
   3  * Copyright 2014 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  ******************************************************************/
  20 /**
  21  * @file caedradapter.h
  22  * @brief This file contains the APIs for EDR adapters to be implemented
  23  */
  24 #ifndef __CA_EDRADAPTER_H_
  25 #define __CA_EDRADAPTER_H_
  26
  27 /**
  28  * BT Interface AP
  29  **/
  30 #include "cacommon.h"
  31 #include "caadapterinterface.h"
  32 #include "uthreadpool.h" /* for thread pool */
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #endif
  38
  39 /**
  40  * @fn  CAInitializeEDR
  41  * @brief  Initialize EDR connectivity interface.
  42  *
  43  * @param[in]  registerCallback  To register EDR interfaces to Connectivity Abstraction Layer
  44  * @param[in]  reqRespCallback  Callback to be notified on receival of request/responses from
  45  * peer bluetooth devices.
  46  * @param[in]  netCallback  Callback to be notified when network adapter state changes.
  47  * @param[in]  threadPool  Thread pool for handling asynchronous tasks.
  48  *
  49  * @return  #CA_STATUS_OK or #CA_ADAPTER_NOT_ENABLED on success otherwise proper error code.
  50  * @retval  #CA_STATUS_OK  Successful
  51  * @retval  #CA_STATUS_INVALID_PARAM  Invalid input parameters
  52  * @retval  #CA_ADAPTER_NOT_ENABLED Initialization is successful, but bluetooth adapter is
  53  * not enabled
  54  * @retval  #CA_STATUS_FAILED Operation failed
  55  */
  56 CAResult_t CAInitializeEDR(CARegisterConnectivityCallback registerCallback,
  57                            CANetworkPacketReceivedCallback reqRespCallback,
  58                            CANetworkChangeCallback netCallback,
  59                            u_thread_pool_t handle);
  60
  61 /**
  62  * @fn  CAStartEDR
  63  * @brief  Starting EDR connectivity adapters. As its peer to peer it doesnot require to start
  64  * any servers.
  65  *
  66  * @return  #CA_STATUS_OK on success otherwise proper error code.
  67  * @retval  #CA_STATUS_OK  Successful
  68  * @retval  #CA_ADAPTER_NOT_ENABLED Bluetooth adapter is not enabled
  69  * @retval  #CA_STATUS_FAILED Operation failed
  70  *
  71  */
  72 CAResult_t CAStartEDR();
  73
  74 /**
  75  * @fn  CAStartEDRListeningServer
  76  * @brief  Starting listening server for receiving multicast search requests.
  77  * Starts RFCOMM Server with prefixed UUID as per OIC specification.
  78  *
  79  * @return  #CA_STATUS_OK on success otherwise proper error code.
  80  * @retval  #CA_STATUS_OK  Successful
  81  * @retval  #CA_SERVER_STARTED_ALREADY  Server is already started and running for the predefined
  82  *                                                            service UUID
  83  * @retval  #CA_STATUS_FAILED Operation failed
  84  *
  85  */
  86 CAResult_t CAStartEDRListeningServer();
  87
  88 /**
  89  * @fn  CAStartEDRDiscoveryServer
  90  * @brief  Starting discovery server for receiving multicast advertisements.
  91  * Starts RFCOMM Server with prefixed UUID as per OIC specification.
  92  *
  93  * @return  #CA_STATUS_OK on success otherwise proper error code.
  94  * @retval  #CA_STATUS_OK  Successful
  95  * @retval  #CA_SERVER_STARTED_ALREADY  Server is already started and running for the predefined
  96  * service UUID
  97  * @retval  #CA_STATUS_FAILED Operation failed
  98  *
  99  */
 100 CAResult_t CAStartEDRDiscoveryServer();
 101
 102 /**
 103  * @fn  CASendEDRUnicastData
 104  * @brief  Sends data to the peer bluetooth OIC device using the adapter connectivity.
 105  *
 106  * @param[in]  remoteEndpoint  Information about peer device to which data needs to be send.
 107  * @param[in]  data  Data which needs to be send to peer OIC device.
 108  * @param[in]  dataLength  Length of data in bytes.
 109  *
 110  * @return  Number of bytes sent on the network. 0 indicates failed to send data.
 111  *
 112  */
 113 uint32_t CASendEDRUnicastData(const CARemoteEndpoint_t *remoteEndpoint, void *data,
 114                             uint32_t dataLength);
 115
 116 /**
 117  * @fn  CASendEDRMulticastData
 118  * @brief  Sends multicast data to all discovered bluetooth OIC devices using the adapter
 119  * connectivity.
 120  *
 121  * @param[in]  data  Data which needs to be send to all discovered bluetooth OIC device.
 122  * @param[in]  dataLength  Length of data in bytes.
 123  *
 124  * @return  Number of bytes sent on the network. 0 indicates failed to send data.
 125  *
 126  */
 127 uint32_t CASendEDRMulticastData(void *data, uint32_t dataLength);
 128
 129 /**
 130  * @fn  CAGetEDRInterfaceInformation
 131  * @brief  Get EDR Connectivity network information.
 132  *
 133  * @param[out]  info  Array of local connectivity information structures.
 134  * @param[out]  size  Size of the array @info.
 135  *
 136  * @return  #CA_STATUS_OK on success otherwise proper error code.
 137  * @retval  #CA_STATUS_OK  Successful
 138  * @retval  #CA_STATUS_INVALID_PARAM  Invalid input parameters
 139  * @retval  #CA_MEMORY_ALLOC_FAILED  Failed to allocate memory
 140  * @retval  #CA_STATUS_FAILED Operation failed
 141  *
 142  */
 143 CAResult_t CAGetEDRInterfaceInformation(CALocalConnectivity_t **info, uint32_t *size);
 144
 145 /**
 146  * @fn  CAReadEDRData
 147  * @brief  Read Synchronous API callback.
 148  *
 149  * @return  #CA_STATUS_OK on success otherwise proper error code.
 150  * @retval  #CA_STATUS_OK  Successful
 151  * @retval  #CA_STATUS_FAILED Operation failed
 152  *
 153  */
 154 CAResult_t CAReadEDRData();
 155
 156 /**
 157  * @fn  CAStopEDR
 158  * @brief  Stopping the adapters and close socket connections
 159  * EDR Stops all RFCOMM servers and close sockets.
 160  *
 161  * @return  #CA_STATUS_OK on success
 162  *
 163  */
 164 CAResult_t CAStopEDR();
 165
 166 /**
 167  * @fn  CATerminateEDR
 168  * @brief  Terminate the EDR connectivity adapter.
 169  * Configuration information will be deleted from further use.
 170  *
 171  */
 172 void CATerminateEDR();
 173
 174 #ifdef __cplusplus
 175 } /* extern "C" */
 176 #endif
 177
 178 #endif  //__CA_EDRADAPTER_H_