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 ******************************************************************/
22 * @file caipinterface.h
23 * This file provides APIs IP client/server/network monitor modules.
26 #ifndef CA_IP_INTERFACE_H_
27 #define CA_IP_INTERFACE_H_
32 #include "cathreadpool.h"
33 #include "uarraylist.h"
41 * Enum for defining different server types.
45 CA_UNICAST_SERVER = 0, /**< Unicast Server */
46 CA_MULTICAST_SERVER, /**< Multicast Server */
47 CA_SECURED_UNICAST_SERVER /**< Secured Unicast Server */
48 } CAAdapterServerType_t;
51 * Callback to be notified on reception of any data from remote OIC devices.
53 * @param[in] sep network endpoint description.
54 * @param[in] data Data received from remote OIC device.
55 * @param[in] dataLength Length of data in bytes.
56 * @pre Callback must be registered using CAIPSetPacketReceiveCallback().
58 typedef void (*CAIPPacketReceivedCallback)(const CASecureEndpoint_t *sep,
63 * Callback to notify error in the IP adapter.
65 * @param[in] endpoint network endpoint description.
66 * @param[in] data Data sent/received.
67 * @param[in] dataLength Length of data in bytes.
68 * @param[in] result result of request from R.I.
69 * @pre Callback must be registered using CAIPSetPacketReceiveCallback().
71 typedef void (*CAIPErrorHandleCallback)(const CAEndpoint_t *endpoint, const void *data,
72 uint32_t dataLength, CAResult_t result);
77 * @param threadPool Thread pool for managing Unicast/Multicast server threads.
78 * @return ::CA_STATUS_OK or Appropriate error code.
79 * @retval ::CA_STATUS_OK Successful.
80 * @retval ::CA_STATUS_INVALID_PARAM Invalid input data.
81 * @retval ::CA_STATUS_FAILED Initialization failed.
84 CAResult_t CAIPStartServer();
86 CAResult_t CAIPStartServer(const ca_thread_pool_t threadPool);
92 void CADeInitializeIPGlobals();
97 void CAIPStopServer();
100 * Starts receiving the multicast traffic.
102 * This will be used in case sleepy device wants to start back receiving the multicast
105 CAResult_t CAIPStartListenServer();
108 * Stops the multicast traffic.
110 * This is to be used by the sleeping device to stop receiving multicast traffic.
111 * Once this is set no multicast traffic will be received. Device can still receive
112 * the unicast traffic.
114 CAResult_t CAIPStopListenServer();
117 * Set this callback for receiving data packets from peer devices.
119 * @param[in] callback Callback to be notified on reception of unicast/multicast data packets.
121 void CAIPSetPacketReceiveCallback(CAIPPacketReceivedCallback callback);
124 * Set socket description for sending unicast UDP data.
125 * Once the Unicast server is started,
126 * the same socket descriptor is used for sending the Unicast UDP data.
128 * @param[in] socketFD Socket descriptor used for sending UDP data.
130 void CAIPSetUnicastSocket(int socketFD);
133 * Set the port number for sending unicast UDP data.
134 * @param[in] port Port number used for sending UDP data.
136 void CAIPSetUnicastPort(uint16_t port);
139 * API to send unicast UDP data.
141 * @param[in] endpoint complete network address to send to.
142 * @param[in] data Data to be send.
143 * @param[in] dataLength Length of data in bytes.
144 * @param[in] isMulticast Whether data needs to be sent to multicast ip.
146 void CAIPSendData(CAEndpoint_t *endpoint,
152 * Get IP adapter connection state.
154 * @return True if IP adapter is connected, otherwise false.
156 bool CAIPIsConnected();
159 * Pull the Received Data.
164 #define CA_SECURE_COAP 5684
165 #define INTERFACE_NAME_MAX 16
169 char name[INTERFACE_NAME_MAX];
173 uint32_t ipv4addr; /**< used for IPv4 only. */
178 * Callback to be notified when IP adapter connection state changes.
180 * @param[in] adapter Transport adapter.
181 * @param[in] status Connection status either ::CA_INTERFACE_UP or ::CA_INTERFACE_DOWN.
182 * @see CAIPSetConnectionStateChangeCallback() for registration.
184 typedef void (*CAIPConnectionStateChangeCallback)(CATransportAdapter_t adapter, CANetworkStatus_t status);
187 * Set callback for receiving local IP adapter connection status.
189 * @param[in] adapter Callback to be notified when IP adapter connection state changes.
191 void CAIPSetConnectionStateChangeCallback(CAIPConnectionStateChangeCallback callback);
194 * Set callback for receiving local IP adapter connection status.
196 * @param[in] callback Callback to be notified when IP adapter connection state changes.
198 void CAIPSetNetworkMonitorCallback(CAIPConnectionStateChangeCallback callback);
201 * Get a list of CAInterface_t items.
203 * @return List of CAInterface_t items.
205 u_arraylist_t *CAIPGetInterfaceInformation(int desiredIndex);
208 * Find a new network interface.
210 * @return Description of interface (or NULL if no change)
212 CAInterface_t *CAFindInterfaceChange();
215 * Let the network monitor update the polling interval.
216 * @param [in] current polling interval
218 * @return desired polling interval
220 int CAGetPollingInterval(int interval);
223 * Tell the IP server an interface has been added.
225 void CAWakeUpForChange();
228 * Start network monitor.
230 * @return ::CA_STATUS_OK or Appropriate error code.
232 CAResult_t CAIPStartNetworkMonitor();
235 * Stops network monitor.
237 * @return ::CA_STATUS_OK or Appropriate error code.
239 CAResult_t CAIPStopNetworkMonitor();
242 * Set callback for error handling.
244 * @param[in] errorHandleCallback callback to notify error to the ipadapter.
246 void CAIPSetErrorHandler(CAIPErrorHandleCallback errorHandleCallback);
252 #endif /* CA_IP_INTERFACE_H_ */