resource/csdk/connectivity/inc/caedrinterface.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 /**
  22  * @file
  23  *
  24  * This file provides APIs for EDR adapter - client, server, network monitor
  25  * modules.
  26  */
  27
  28 #ifndef CA_EDR_INTERFACE_H_
  29 #define CA_EDR_INTERFACE_H_
  30
  31 #include "caedradapter.h"
  32
  33 #ifdef __cplusplus
  34 extern "C"
  35 {
  36 #endif
  37
  38 #ifndef OIC_EDR_SERVICE_ID
  39 #define OIC_EDR_SERVICE_ID "12341234-1C25-481F-9DFB-59193D238280"
  40 #endif //OIC_EDR_SERVICE_ID
  41
  42 typedef enum
  43 {
  44     STATE_DISCONNECTED, /**< State is Disconnected. */
  45     STATE_CONNECTED     /**< State is Connected. */
  46 } CAConnectedState_t;
  47
  48 typedef struct connected_state
  49 {
  50     uint8_t address[CA_MACADDR_SIZE];
  51     CAConnectedState_t state;
  52 } state_t;
  53
  54 /**
  55  * Enum for defining different server types.
  56  */
  57 typedef enum
  58 {
  59     CA_UNICAST_SERVER = 0,    /**< Unicast Server. */
  60     CA_MULTICAST_SERVER,      /**< Multicast Server. */
  61     CA_SECURED_UNICAST_SERVER /**< Secured Unicast Server. */
  62 } CAAdapterServerType_t;
  63
  64 /**
  65  * Structure to maintain the information of data in message queue.
  66  */
  67 typedef struct
  68 {
  69     CAEndpoint_t *remoteEndpoint;       /**< Remote Endpoint. */
  70     void *data;                         /**< Data to be sent. */
  71     uint32_t dataLen;                   /**< Length of the data to be sent. */
  72 } CAEDRData;
  73
  74 /**
  75  * Structure to maintain the adapter information and its status.
  76  */
  77 typedef struct
  78 {
  79     CAEndpoint_t *info;          /**< Local Connectivity Information. */
  80     CANetworkStatus_t status;    /**< Network Status. */
  81 } CAEDRNetworkEvent;
  82
  83 /**
  84  * This will be used during the Receiver of network requests and response.
  85  * @param[in] remoteAddress EDR address of remote OIC device from which data received.
  86  * @param[in] data          Data received.
  87  * @param[in] dataLength    Length of the Data received.
  88  * @param[out] sentLength    Length of the sent data.
  89  * @pre Callback must be registered using CAEDRSetPacketReceivedCallback().
  90  */
  91 typedef void (*CAEDRDataReceivedCallback)(const char *remoteAddress, const void *data,
  92                                           uint32_t dataLength, uint32_t *sentLength);
  93
  94 /**
  95  * This will be used during change in network status.
  96  * @param[in] status        Network Status of the adapter.
  97  */
  98 typedef void (*CAEDRNetworkStatusCallback)(CANetworkStatus_t status);
  99
 100 /**
 101  * Callback to notify the error in the EDR adapter.
 102  * @param[in]  remoteAddress   Remote EDR Address.
 103  * @param[in]  data            data containing token, uri and coap data.
 104  * @param[in]  dataLength      length of data.
 105  * @param[in]  result          error code as defined in ::CAResult_t.
 106  * @pre Callback must be registered using CAEDRSetPacketReceivedCallback().
 107  */
 108 typedef void (*CAEDRErrorHandleCallback)(const char *remoteAddress, const void *data,
 109         uint32_t dataLength, CAResult_t result);
 110
 111 /**
 112  * Initialize the network monitor module
 113  * @param[in]  threadPool   Threadpool Handle.
 114  * @return ::CA_STATUS_OK or Appropriate error code.
 115  * @retval ::CA_STATUS_OK  Successful.
 116  * @retval ::CA_ADAPTER_NOT_ENABLED Initialization is successful, but
 117  * bluetooth adapter is not enabled.
 118  * @retval ::CA_STATUS_FAILED Operation failed.
 119  * @see  CAEDRTerminateNetworkMonitor().
 120  */
 121 CAResult_t CAEDRInitializeNetworkMonitor(const ca_thread_pool_t threadPool);
 122
 123 /**
 124  * Deinitialize with bluetooth adapter.
 125  * @pre    CAEDRInitializeNetworkMonitor() should be invoked before using
 126  * this API.
 127  * @see    CAEDRInitializeNetworkMonitor().
 128  */
 129 void CAEDRTerminateNetworkMonitor();
 130
 131 /**
 132  * Start Network Monitoring Process.
 133  * @return ::CA_STATUS_OK or Appropriate error code.
 134  */
 135 CAResult_t CAEDRStartNetworkMonitor();
 136
 137 /**
 138  * Stop Network Monitoring Process.
 139  * @return ::CA_STATUS_OK or Appropriate error code.
 140  */
 141 CAResult_t CAEDRStopNetworkMonitor();
 142
 143 /**
 144  * Sets the callback and Starts discovery for nearby OIC bluetooth devices.
 145  *
 146  * @return ::CA_STATUS_OK or Appropriate error code.
 147  * @retval ::CA_STATUS_OK  Successful.
 148  * @retval ::CA_STATUS_FAILED Operation failed.
 149  */
 150 CAResult_t CAEDRClientSetCallbacks();
 151
 152 /**
 153  * Resetting callbacks with bluetooth framework and stop OIC device discovery.
 154  * @pre    CAEDRClientSetCallbacks() should be invoked before using this API.
 155  * @see    CAEDRClientSetCallbacks().
 156  */
 157 void CAEDRClientUnsetCallbacks();
 158
 159 /**
 160  * Used to initialize the EDR client module where mutex is initialized.
 161  */
 162 void CAEDRInitializeClient(ca_thread_pool_t handle);
 163
 164 /**
 165  * Destroys the Device list and mutex.
 166  */
 167 void CAEDRClientTerminate();
 168
 169 /**
 170  * Closes all the client connection to peer bluetooth devices.
 171  */
 172 void CAEDRClientDisconnectAll();
 173
 174 /**
 175  * Register callback to send the received packets from remote bluetooth
 176  * device to BTAdapter.
 177  *
 178  * @param[in]  packetReceivedCallback Callback function to register for
 179  * sending network packets to EDR Adapter.
 180  */
 181 void CAEDRSetPacketReceivedCallback(CAEDRDataReceivedCallback packetReceivedCallback);
 182
 183 /**
 184  * Register callback for receiving local bluetooth adapter state.
 185  *
 186  * @param[in]  networkStateChangeCallback Callback function to register
 187  * for receiving local bluetooth adapter status.
 188  */
 189 void CAEDRSetNetworkChangeCallback(CAEDRNetworkStatusCallback networkStateChangeCallback);
 190
 191 /**
 192  * set error callback to notify error in EDR adapter.
 193  *
 194  * @param[in]  errorHandleCallback Callback function to notify the error
 195  * in the EDR adapter.
 196  */
 197 void CAEDRSetErrorHandler(CAEDRErrorHandleCallback errorHandleCallback);
 198
 199
 200 /**
 201  * Get the local bluetooth adapter information.
 202  *
 203  * @param[out]  info Local bluetooth adapter information.
 204  *
 205  * @return ::CA_STATUS_OK or Appropriate error code.
 206  * @retval ::CA_STATUS_OK  Successful.
 207  * @retval ::CA_STATUS_INVALID_PARAM  Invalid input arguments.
 208  * @retval ::CA_STATUS_FAILED Operation failed.
 209  *
 210  * @see CALocalConnectivity_t
 211  *
 212  */
 213 CAResult_t CAEDRGetInterfaceInformation(CAEndpoint_t **info);
 214
 215 /**
 216  * Start RFCOMM server for given service UUID
 217  *
 218  * @param[in]  handle       Threadpool Handle.
 219  *
 220  * @return ::CA_STATUS_OK or Appropriate error code.
 221  * @retval ::CA_STATUS_OK  Successful.
 222  * @retval ::CA_STATUS_INVALID_PARAM  Invalid input arguments.
 223  * @retval ::CA_STATUS_FAILED Operation failed.
 224  *
 225  */
 226 CAResult_t CAEDRServerStart(ca_thread_pool_t handle);
 227
 228 /**
 229  * Stop RFCOMM server
 230  *
 231  * @return ::CA_STATUS_OK or Appropriate error code.
 232  * @retval ::CA_STATUS_OK  Successful.
 233  * @retval ::CA_STATUS_FAILED Operation failed.
 234  */
 235 CAResult_t CAEDRServerStop();
 236
 237 /**
 238  * Terminate server for EDR.
 239  */
 240 void CAEDRServerTerminate();
 241
 242 /**
 243  * All received data will be notified to upper layer.
 244  *
 245  * @return ::CA_STATUS_OK or Appropriate error code.
 246  * @retval ::CA_STATUS_OK  Successful.
 247  * @retval ::CA_STATUS_FAILED Operation failed.
 248  *
 249  */
 250 CAResult_t CAEDRManagerReadData();
 251
 252 /**
 253  * This function gets bluetooth adapter enable state.
 254  * @param[out]  state    State of the Adapter.
 255  * @return ::CA_STATUS_OK or Appropriate error code.
 256  */
 257 CAResult_t CAEDRGetAdapterEnableState(bool *state);
 258
 259 /**
 260  * This function sends data to specified remote bluetooth device.
 261  * @param[in]  remoteAddress   Remote EDR Address.
 262  * @param[in]  data            Data to be sent.
 263  * @param[in]  dataLength      Length of the data to be sent.
 264  * @return ::CA_STATUS_OK or Appropriate error code.
 265  */
 266 CAResult_t CAEDRClientSendUnicastData(const char *remoteAddress, const void *data,
 267                                       uint32_t dataLength);
 268
 269 /**
 270  * This function sends data to all bluetooth devices running OIC service.
 271  * @param[in]  data            Data to be sent.
 272  * @param[in]  dataLength      Length of the data to be sent.
 273  * @return ::CA_STATUS_OK or Appropriate error code.
 274  */
 275 CAResult_t CAEDRClientSendMulticastData(const void *data, uint32_t dataLength);
 276
 277 /**
 278  * This function gets bonded bluetooth device list
 279  * @return ::CA_STATUS_OK or Appropriate error code.
 280  */
 281 CAResult_t CAEDRGetBondedDeviceList();
 282
 283 #ifdef __cplusplus
 284 } /* extern "C" */
 285 #endif
 286
 287 #endif /* CA_EDR_INTERFACE_H_ */