resource/csdk/connectivity/inc/caadapterinterface.h

   1 /* *****************************************************************
   2  *
   3  * Copyright 2015 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 contains the APIs for adapters to be implemented.
  25  */
  26
  27 #ifndef CA_ADAPTER_INTERFACE_H_
  28 #define CA_ADAPTER_INTERFACE_H_
  29
  30 #include "cacommon.h"
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #endif
  36
  37 /**
  38  * Starting connectivity adapters and each adapter have transport specific behavior.
  39  * Transport Specific Behavior:
  40  * WIFI/ETH connectivity Starts unicast server on  all available IPs and defined
  41  * port number as per specification.
  42  * EDR will not start any specific servers.
  43  * LE will not start any specific servers.
  44  * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED
  45  *  ERROR CODES (::CAResult_t error codes in cacommon.h).
  46  */
  47 typedef CAResult_t (*CAAdapterStart)();
  48
  49 /**
  50  * Starting listening server for receiving multicast search requests
  51  * Transport Specific Behavior:
  52  * WIFI/ETH Starts multicast server on  all available IPs and defined
  53  * port number and as per specification.
  54  * EDR  Starts RFCOMM Server with prefixed UUID as per specification.
  55  * LE Start GATT Server with prefixed UUID and Characteristics as per OIC Specification.
  56  * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED
  57  * ERROR CODES (::CAResult_t error codes in cacommon.h).
  58  */
  59 typedef CAResult_t (*CAAdapterStartListeningServer)();
  60
  61 /**
  62  * Stopping listening server to not receive multicast search requests
  63  * Transport Specific Behavior:
  64  * WIFI/ETH Stops multicast server on  all available IPs. This is required for the
  65  * thin device that call this function once all local resources are pushed to the
  66  * resource directory.
  67  * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED
  68  * ERROR CODES (::CAResult_t error codes in cacommon.h).
  69  */
  70 typedef CAResult_t (*CAAdapterStopListeningServer)();
  71
  72 /**
  73  * for starting discovery servers for receiving multicast advertisements
  74  * Transport Specific Behavior:
  75  * WIFI/ETH Starts multicast server on all available IPs and defined port
  76  * number as per OIC Specification.
  77  * EDR Starts RFCOMM Server with prefixed UUID as per OIC Specification.
  78  * LE Starts GATT Server with prefixed UUID and Characteristics as per OIC Specification.
  79  * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED
  80  * ERROR CODES (::CAResult_t error codes in cacommon.h).
  81  */
  82 typedef CAResult_t (*CAAdapterStartDiscoveryServer)();
  83
  84 /**
  85  * Sends data to the endpoint using the adapter connectivity.
  86  * Note: length must be > 0.
  87  * @param[in]   endpoint        Remote Endpoint information (like ipaddress , port,
  88  * reference uri and connectivity type) to which the unicast data has to be sent.
  89  * @param[in]   data            Data which required to be sent.
  90  * @param[in]   dataLen         Size of data to be sent.
  91  * @return The number of bytes sent on the network. Return value equal to -1 indicates error.
  92  */
  93 typedef int32_t (*CAAdapterSendUnicastData)(const CAEndpoint_t *endpoint,
  94                                             const void *data, uint32_t dataLen);
  95
  96 /**
  97  * Sends Multicast data to the endpoint using the adapter connectivity.
  98  * Note: length must be > 0.
  99  * @param[in]   endpoint        Remote Endpoint information (like ipaddress , port,
 100  * @param[in]   data            Data which required to be sent.
 101  * @param[in]   dataLen         Size of data to be sent.
 102  * @return The number of bytes sent on the network. Return value equal to -1 indicates error.
 103  */
 104 typedef int32_t (*CAAdapterSendMulticastData)(const CAEndpoint_t *endpoint,
 105         const void *data, uint32_t dataLen);
 106
 107 /**
 108  * Get Network Information.
 109  * @param[out]   info           Local connectivity information structures
 110  * @param[out]   size           Number of local connectivity structures.
 111  * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h)
 112  */
 113 typedef CAResult_t (*CAAdapterGetNetworkInfo)(CAEndpoint_t **info, uint32_t *size);
 114
 115 /**
 116  * Read Synchronous API callback.
 117  * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h)
 118  */
 119 typedef CAResult_t (*CAAdapterReadData)();
 120
 121 /**
 122  * Stopping the adapters and close socket connections.
 123  * Transport Specific Behavior:
 124  * WIFI/ETH Stops all listening servers and close sockets.
 125  * EDR Stops all RFCOMM servers and close sockets.
 126  * LE Stops all GATT servers and close sockets.
 127  * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
 128  */
 129 typedef CAResult_t (*CAAdapterStop)();
 130
 131 /**
 132  * Terminate the connectivity adapter.Configuration information will be deleted from
 133  * further use. Freeing Memory of threadpool and mutexs and cleanup will be done.
 134  */
 135 typedef void (*CAAdapterTerminate)();
 136
 137 /**
 138  * Connectivity handler information for adapter.
 139  */
 140 typedef struct
 141 {
 142     /** Start Transport specific functions. */
 143     CAAdapterStart startAdapter;
 144
 145     /** Listening Server function address. */
 146     CAAdapterStartListeningServer startListenServer;
 147
 148     /** Stops receiving the multicast traffic. */
 149     CAAdapterStopListeningServer stopListenServer;
 150
 151     /** Discovery Server function address. **/
 152     CAAdapterStartDiscoveryServer startDiscoveryServer;
 153
 154     /** Unicast data function address. **/
 155     CAAdapterSendUnicastData sendData;
 156
 157     /** Multicast data function address. **/
 158     CAAdapterSendMulticastData sendDataToAll;
 159
 160     /** Get Networking information. **/
 161     CAAdapterGetNetworkInfo GetnetInfo;
 162
 163     /** Read Data function address. **/
 164     CAAdapterReadData readData;
 165
 166     /** Stop Transport specific functions. */
 167     CAAdapterStop stopAdapter;
 168
 169     /** Terminate function address stored in this pointer. **/
 170     CAAdapterTerminate terminate;
 171
 172     /** Type of transport adapter. **/
 173     CATransportAdapter_t cType;
 174 } CAConnectivityHandler_t;
 175
 176 /**
 177  * This will be used during the registration of adapters call backs to the common logic.
 178  * @see ::CAConnectivityHandler_t
 179  */
 180 typedef void (*CARegisterConnectivityCallback)(CAConnectivityHandler_t handler);
 181
 182 /**
 183  * This will be used during the receive of network requests and response.
 184  * @see SendUnicastData(), SendMulticastData()
 185  */
 186 typedef void (*CANetworkPacketReceivedCallback)(const CASecureEndpoint_t *sep,
 187                                             const void *data, uint32_t dataLen);
 188
 189 /**
 190  * This will be used to notify network changes to the connectivity common logic layer.
 191  * @see SendUnicastData(), SendMulticastData()
 192  */
 193 typedef void (*CANetworkChangeCallback)(const CAEndpoint_t *info, CANetworkStatus_t status);
 194
 195 /**
 196  * This will be used to notify error result to the connectivity common logic layer.
 197  */
 198 typedef void (*CAErrorHandleCallback)(const CAEndpoint_t *endpoint,
 199                                       const void *data, uint32_t dataLen,
 200                                       CAResult_t result);
 201
 202 #ifdef __cplusplus
 203 } /* extern "C" */
 204 #endif
 205
 206 #endif  /* CA_ADAPTER_INTERFACE_H_ */
 207