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
  33 #ifdef __cplusplus
  34 extern "C"
  35 {
  36 #endif
  37
  38 #ifndef BLUETOOTH_ADAPTER_TAG
  39 #define BLUETOOTH_ADAPTER_TAG "CA_EDR"
  40 #endif //BLUETOOTH_ADAPTER_TAG
  41 /**
  42  * @brief Initialize EDR connectivity interface.
  43  * @param registerCallback [IN] To register EDR interfaces to Connectivity Abstraction Layer
  44  * @param reqRespCallback [IN] sending responses and discovery messages from unicast , multicast servers
  45  * @param netCallback [IN] Intimate the network additions to Connectivity Abstraction Layer.
  46  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  47  */
  48 CAResult_t CAInitializeEDR(CARegisterConnectivityCallback registerCallback,
  49         CANetworkPacketReceivedCallback reqRespCallback, CANetworkChangeCallback netCallback);
  50
  51 /**
  52  * @brief Starting EDR connectivity adapters .As its peer to peer it doesnot require to start any servers
  53  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  54  */
  55 CAResult_t CAStartEDR();
  56
  57 /**
  58  * @brief Starting listening server for receiving multicast search requests
  59  * Transport Specific Behavior:
  60  *   EDR  Starts RFCOMM Server with prefixed UUID as per specification.
  61  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  62  */
  63 CAResult_t CAStartEDRListeningServer();
  64
  65 /**
  66  * @brief for starting discovery servers for receiving multicast advertisements
  67  * Transport Specific Behavior:
  68  *   EDR Starts RFCOMM server with prefixed UUID as per OIC Specification.
  69  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  70  */
  71 CAResult_t CAStartEDRDiscoveryServer();
  72
  73 /**
  74  * @brief Sends data to the endpoint using the adapter connectivity.
  75  * Note: length must be > 0.
  76  * @param   endpoint    [IN]    Remote Endpoint information (like ipaddress , port, reference uri and connectivity type) to
  77  *                              which the unicast data has to be sent.
  78  * @param   data        [IN]    Data which required to be sent.
  79  * @param   dataLen     [IN]    Size of data to be sent.
  80  * @return - The number of bytes sent on the network. Return value equal to zero indicates error.
  81  */
  82 uint32_t CASendEDRUnicastData(const CARemoteEndpoint_t* endpoint, void* data, uint32_t dataLen);
  83
  84 /**
  85  * @brief Sends Multicast data to the endpoint using the EDR connectivity.
  86  * Note: length must be > 0.
  87  * @param   data        [IN]    Data which required to be sent.
  88  * @param   dataLen     [IN]    Size of data to be sent.
  89  * @return - The number of bytes sent on the network. Return value equal to zero indicates error.
  90  */
  91 uint32_t CASendEDRMulticastData(void* data, uint32_t dataLen);
  92
  93 /**
  94  * @brief Starts notification server on EDR adapters.
  95  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  96  */
  97 CAResult_t CAStartEDRNotifyServer();
  98
  99 /**
 100  * @brief Send notification information.
 101  * Note: length must be > 0.
 102  * @param   endpoint    [IN]    Remote Endpoint information (like ipaddress , port, reference uri and connectivity type) to
 103  *                              which the unicast data has to be sent.
 104  * @param   data        [IN]    Data which required to be sent.
 105  * @param   dataLen     [IN]    Size of data to be sent.
 106  * @return - The number of bytes sent on the network. Return value equal to zero indicates error.
 107  */
 108 uint32_t CASendEDRNotification(const CARemoteEndpoint_t* endpoint, void* data, uint32_t dataLen);
 109
 110 /**
 111  * @brief Get EDR Connectivity network information
 112  * @param   info        [OUT]   Local connectivity information structures
 113  * @param   size        [OUT]   Number of local connectivity structures.
 114  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
 115  */
 116 CAResult_t CAGetEDRInterfaceInformation(CALocalConnectivityt_t** info, uint32_t* size);
 117
 118 /**
 119  * @brief Read Synchronous API callback.
 120  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
 121  */
 122 CAResult_t CAReadEDRData();
 123
 124 /**
 125  * @brief Stopping the adapters and close socket connections
 126  *   EDR Stops all RFCOMM servers and close sockets.
 127  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
 128  */
 129 CAResult_t CAStopEDR();
 130
 131 /**
 132  * @brief Terminate the EDR connectivity adapter.
 133  * Configuration information will be deleted from further use
 134  */
 135 void CATerminateEDR();
 136
 137 #ifdef __cplusplus
 138 } /* extern "C" */
 139 #endif
 140
 141 #endif  //__CA_EDRADAPTER_H_