resource/csdk/connectivity/inc/caraadapter.h

   1 /******************************************************************
   2 //
   3 // Copyright 2015 Intel Mobile Communications GmbH 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 caraadapter.h
  23  * @brief This file contains the APIs for IP Adapter.
  24  */
  25 #ifndef CA_RA_ADAPTER_H_
  26 #define CA_RA_ADAPTER_H_
  27
  28 #include "cacommon.h"
  29 #include "caadapterinterface.h"
  30 #include "cathreadpool.h"
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #endif
  36
  37
  38 /**
  39  * @brief API to initialize RA Interface.
  40  * @param registerCallback      [IN] Callback to register RA interfaces to Connectivity
  41  *                                   Abstraction Layer
  42  * @param networkPacketCallback [IN] Callback to notify request and response messages from server(s)
  43  *                                   started at Connectivity Abstraction Layer.
  44  * @param netCallback           [IN] Callback to notify the network additions to Connectivity
  45  *                                   Abstraction Layer.
  46  * @param handle                [IN] Threadpool Handle
  47  * @return  #CA_STATUS_OK or Appropriate error code
  48  */
  49 CAResult_t CAInitializeRA(CARegisterConnectivityCallback registerCallback,
  50                           CANetworkPacketReceivedCallback networkPacketCallback,
  51                           CANetworkChangeCallback netCallback,
  52                           ca_thread_pool_t handle);
  53
  54
  55 /**
  56  * @brief Start RA Interface adapter.
  57  * @return  #CA_STATUS_OK or Appropriate error code
  58  */
  59 CAResult_t CAStartRA();
  60
  61 /**
  62  * @brief Sends data to the endpoint using the adapter connectivity.
  63  * @param   endpoint    [IN]    Remote Endpoint information (like ipaddress , port,
  64  * reference uri and transport type) to which the unicast data has to be sent.
  65  * @param   data        [IN]    Data which is required to be sent.
  66  * @param   dataLen     [IN]    Size of data to be sent.
  67  * @return The number of bytes sent on the network. Return value equal to -1 indicates error.
  68  * @remarks dataLen must be > 0.
  69  */
  70 int32_t CASendRAUnicastData(const CAEndpoint_t *endpoint, const void *data,
  71                             uint32_t dataLen);
  72
  73 /**
  74  * @brief Get RA Connectivity network information
  75  * @param   info        [OUT]   Local connectivity information structures
  76  * @param   size        [OUT]   Number of local connectivity structures.
  77  * @return  #CA_STATUS_OK or Appropriate error code
  78  * @remarks info is allocated in this API and should be freed by the caller.
  79  */
  80 CAResult_t CAGetRAInterfaceInformation(CAEndpoint_t **info, uint32_t *size);
  81
  82 /**
  83  * @brief Stops RA server and de-register XMPP callback listeners
  84  * @return  #CA_STATUS_OK or Appropriate error code
  85  */
  86 CAResult_t CAStopRA();
  87
  88 /**
  89  * @brief Terminate the RA connectivity adapter.
  90  * Configuration information will be deleted from further use
  91  * @return  NONE
  92  */
  93 void CATerminateRA();
  94
  95 /**
  96  * @brief   Set Remote Access information for XMPP Client.
  97  * @param   caraInfo            [IN] remote access info.
  98  *
  99  * @return  CA_STATUS_OK
 100  */
 101 CAResult_t CASetRAInfo(const CARAInfo_t *caraInfo);
 102
 103 /**
 104  * These functions are not applicable to Remote Access adapter
 105  */
 106 int32_t CASendRAMulticastData(const CAEndpoint_t *endpoint,
 107                  const void *data, uint32_t dataLen);
 108 /**
 109  * @brief Start listening server for receiving search requests.
 110  * @return  #CA_NOT_SUPPORTED
 111  */
 112 CAResult_t CAStartRAListeningServer();
 113
 114 /**
 115  * @brief Start discovery servers for receiving advertisements.
 116  * @return  #CA_NOT_SUPPORTED
 117  */
 118 CAResult_t CAStartRADiscoveryServer();
 119
 120 /**
 121  * @brief Read Synchronous API callback.
 122  * @return  #CA_NOT_SUPPORTED
 123  */
 124 CAResult_t CAReadRAData();
 125
 126 #ifdef __cplusplus
 127 } /* extern "C" */
 128 #endif
 129
 130 #endif  //CA_RA_ADAPTER_H_
 131