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"
33 #include "cathreadpool.h" /* for thread pool */
43 * @brief Initializes different adapters based on the compilation flags.
46 void CAInitializeAdapters();
49 * @brief Initializes different adapters based on the compilation flags.
50 * @param handle [IN] thread pool handle created by message handler for different adapters.
53 void CAInitializeAdapters(ca_thread_pool_t handle);
57 * @brief Set the received packets callback for message handler
58 * @param callback [IN] message handler callback to receive packets from different adapters.
61 void CASetPacketReceivedCallback(CANetworkPacketReceivedCallback callback);
64 * @brief Set the error handler callback for message handler
65 * @param errorCallback [IN] error handler callback from adapters
68 void CASetErrorHandleCallback(CAErrorHandleCallback errorCallback);
71 * @brief Set the network status changed callback for message handler
72 * @param callback [IN] message handler network status callback to receive network changes.
75 void CASetNetworkChangeCallback(CANetworkChangeCallback callback);
78 * @brief Starting different connectivity adapters based on the network selection.
79 * @param transportType [IN] interested network for starting
80 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
82 CAResult_t CAStartAdapter(CATransportAdapter_t transportType);
85 * @brief Stopping different connectivity adapters based on the network un-selection.
86 * @param transportType [IN] network type that want to stop
89 void CAStopAdapter(CATransportAdapter_t transportType);
93 * @brief Set Remote Access information for XMPP Client.
94 * @param caraInfo [IN] remote access info.
96 * @return CA_STATUS_OK
98 CAResult_t CASetAdapterRAInfo(const CARAInfo_t *caraInfo);
102 * @brief Get network information such as ipaddress and mac information
103 * @param info [OUT] connectivity information such as ipaddress and mac information
104 * @param size [OUT] number of connectivity information structures
105 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
107 CAResult_t CAGetNetworkInfo(CAEndpoint_t **info, uint32_t *size);
110 * @brief Sends unicast data to the remote endpoint
111 * @param endpoint [IN] endpoint information where the data has to be sent
112 * @param data [IN] data that needs to be sent
113 * @param length [IN] length of the data that needs to be sent
114 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
116 CAResult_t CASendUnicastData(const CAEndpoint_t *endpoint, const void *data, uint32_t length);
119 * @brief Sends multicast data to all endpoints in the network.
120 * @param endpoint [IN] endpoint information where the data has to be sent
121 * @param data [IN] data that needs to be sent
122 * @param length [IN] length of the data that needs to be sent
123 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
126 CAResult_t CASendMulticastData(const CAEndpoint_t *endpoint, const void *data, uint32_t length);
129 * @brief Start listening servers to receive search requests from clients
130 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
132 CAResult_t CAStartListeningServerAdapters();
135 * @brief Start discovery servers to receive advertisements from server
136 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
138 CAResult_t CAStartDiscoveryServerAdapters();
141 * @brief Terminates the adapters which are initialized during the initialization
144 void CATerminateAdapters();
148 * @brief Checks for available data and reads it
149 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
151 CAResult_t CAReadData();
158 #endif /* CA_INTERFACE_CONTROLLER_H_ */