1 /* ****************************************************************
3 * Copyright 2014 Samsung Electronics All Rights Reserved.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 ******************************************************************/
24 * This file contains common utility function for CA transport adaptors.
27 #ifndef CA_INTERFACE_CONTROLLER_H_
28 #define CA_INTERFACE_CONTROLLER_H_
30 #include "caadapterinterface.h"
31 #include "cathreadpool.h" /* for thread pool */
39 * @brief Initializes different adapters based on the compilation flags.
40 * @param handle [IN] thread pool handle created by message handler for different adapters.
43 void CAInitializeAdapters(ca_thread_pool_t handle);
46 * @brief Set the received packets callback for message handler
47 * @param callback [IN] message handler callback to receive packets from different adapters.
50 void CASetPacketReceivedCallback(CANetworkPacketReceivedCallback callback);
53 * @brief Set the error handler callback for message handler
54 * @param errorCallback [IN] error handler callback from adapters
57 void CASetErrorHandleCallback(CAErrorHandleCallback errorCallback);
60 * @brief Set the network status changed callback for message handler
61 * @param callback [IN] message handler network status callback to receive network changes.
64 void CASetNetworkChangeCallback(CANetworkChangeCallback callback);
67 * @brief Starting different connectivity adapters based on the network selection.
68 * @param transportType [IN] interested network for starting
69 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
71 CAResult_t CAStartAdapter(CATransportAdapter_t transportType);
74 * @brief Stopping different connectivity adapters based on the network un-selection.
75 * @param transportType [IN] network type that want to stop
78 void CAStopAdapter(CATransportAdapter_t transportType);
81 * @brief Get network information such as ipaddress and mac information
82 * @param info [OUT] connectivity information such as ipaddress and mac information
83 * @param size [OUT] number of connectivity information structures
84 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
86 CAResult_t CAGetNetworkInfo(CAEndpoint_t **info, uint32_t *size);
89 * @brief Sends unicast data to the remote endpoint
90 * @param endpoint [IN] endpoint information where the data has to be sent
91 * @param data [IN] data that needs to be sent
92 * @param length [IN] length of the data that needs to be sent
93 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
95 CAResult_t CASendUnicastData(const CAEndpoint_t *endpoint, const void *data, uint32_t length);
98 * @brief Sends multicast data to all endpoints in the network.
99 * @param endpoint [IN] endpoint information where the data has to be sent
100 * @param data [IN] data that needs to be sent
101 * @param length [IN] length of the data that needs to be sent
102 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
105 CAResult_t CASendMulticastData(const CAEndpoint_t *endpoint, const void *data, uint32_t length);
108 * @brief Start listening servers to receive search requests from clients
109 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
111 CAResult_t CAStartListeningServerAdapters();
114 * @brief Start discovery servers to receive advertisements from server
115 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
117 CAResult_t CAStartDiscoveryServerAdapters();
120 * @brief Terminates the adapters which are initialized during the initialization
123 void CATerminateAdapters();
129 #endif /* CA_INTERFACE_CONTROLLER_H_ */