resource/csdk/connectivity/inc/cainterfacecontroller.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 contains common utility function for CA transport adaptors.
  25  */
  26
  27 #ifndef CA_INTERFACE_CONTROLLER_H_
  28 #define CA_INTERFACE_CONTROLLER_H_
  29
  30 #include "caadapterinterface.h"
  31 #include "cathreadpool.h" /* for thread pool */
  32
  33 #ifdef __cplusplus
  34 extern "C"
  35 {
  36 #endif
  37
  38 /**
  39  * @brief   Initializes different adapters based on the compilation flags.
  40  * @param   handle         [IN]    thread pool handle created by message handler for different adapters.
  41  * @return  none
  42  */
  43 void CAInitializeAdapters(ca_thread_pool_t handle);
  44
  45 /**
  46  * @brief   Set the received packets callback for message handler
  47  * @param   callback       [IN]    message handler callback to receive packets from different adapters.
  48  * @return  none
  49  */
  50 void CASetPacketReceivedCallback(CANetworkPacketReceivedCallback callback);
  51
  52 /**
  53  * @brief   Set the network status changed callback for message handler
  54  * @param   callback       [IN]    message handler network status callback to receive network changes.
  55  * @return  none
  56  */
  57 void CASetNetworkChangeCallback(CANetworkChangeCallback callback);
  58
  59 /**
  60  * @brief   Starting different connectivity adapters based on the network selection.
  61  * @param   transportType   [IN]    interested network for starting
  62  * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  63  */
  64 CAResult_t CAStartAdapter(CATransportType_t transportType);
  65
  66 /**
  67  * @brief   Stopping different connectivity adapters based on the network un-selection.
  68  * @param   transportType   [IN]    network type that want to stop
  69  * @return  none
  70  */
  71 void CAStopAdapter(CATransportType_t transportType);
  72
  73 /**
  74  * @brief   Get network information such as ipaddress and mac information
  75  * @param   info           [OUT]    connectivity information such as ipaddress and mac information
  76  * @param   size           [OUT]    number of connectivity information structures
  77  * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  78  */
  79 CAResult_t CAGetNetworkInfo(CALocalConnectivity_t **info, uint32_t *size);
  80
  81 /**
  82  * @brief   Sends unicast data to the remote endpoint
  83  * @param   endpoint       [IN]    endpoint information where the data has to be sent
  84  * @param   data           [IN]    data that needs to be sent
  85  * @param   length         [IN]    length of the data that needs to be sent
  86  * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  87  */
  88 CAResult_t CASendUnicastData(const CARemoteEndpoint_t *endpoint, const void *data, uint32_t length);
  89
  90 /**
  91  * @brief   Sends multicast data to all endpoints in the network.
  92  * @param   data           [IN]    data that needs to be sent
  93  * @param   length         [IN]    length of the data that needs to be sent
  94  * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
  95  */
  96
  97 CAResult_t CASendMulticastData(const void *data, uint32_t length);
  98
  99 /**
 100  * @brief   Start listening servers to receive search requests from clients
 101  * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
 102  */
 103 CAResult_t CAStartListeningServerAdapters();
 104
 105 /**
 106  * @brief   Start discovery servers to receive advertisements from server
 107  * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
 108  */
 109 CAResult_t CAStartDiscoveryServerAdapters();
 110
 111 /**
 112  * @brief   Terminates  the adapters which are initialized during the initialization
 113  * @return  none
 114  */
 115 void CATerminateAdapters();
 116
 117 #ifdef __cplusplus
 118 } /* extern "C" */
 119 #endif
 120
 121 #endif /* CA_INTERFACE_CONTROLLER_H_ */
 122