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 * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
57 * @pre Callback must be registered using CAIPSetPacketReceiveCallback().
59 typedef CAResult_t (*CAIPPacketReceivedCallback)(const CASecureEndpoint_t *sep,
64 * Callback to notify error in the IP adapter.
66 * @param[in] endpoint network endpoint description.
67 * @param[in] data Data sent/received.
68 * @param[in] dataLength Length of data in bytes.
69 * @param[in] result result of request from R.I.
70 * @pre Callback must be registered using CAIPSetPacketReceiveCallback().
72 typedef void (*CAIPErrorHandleCallback)(const CAEndpoint_t *endpoint, const void *data,
73 uint32_t dataLength, CAResult_t result);
78 * @param threadPool Thread pool for managing Unicast/Multicast server threads.
79 * @return ::CA_STATUS_OK or Appropriate error code.
80 * @retval ::CA_STATUS_OK Successful.
81 * @retval ::CA_STATUS_INVALID_PARAM Invalid input data.
82 * @retval ::CA_STATUS_FAILED Initialization failed.
85 CAResult_t CAIPStartServer();
87 CAResult_t CAIPStartServer(const ca_thread_pool_t threadPool);
93 void CADeInitializeIPGlobals();
98 void CAIPStopServer();
101 * Starts receiving the multicast traffic.
103 * This will be used in case sleepy device wants to start back receiving the multicast
106 CAResult_t CAIPStartListenServer();
109 * Stops the multicast traffic.
111 * This is to be used by the sleeping device to stop receiving multicast traffic.
112 * Once this is set no multicast traffic will be received. Device can still receive
113 * the unicast traffic.
115 CAResult_t CAIPStopListenServer();
118 * Set this callback for receiving data packets from peer devices.
120 * @param[in] callback Callback to be notified on reception of unicast/multicast data packets.
122 void CAIPSetPacketReceiveCallback(CAIPPacketReceivedCallback callback);
125 * Set socket description for sending unicast UDP data.
126 * Once the Unicast server is started,
127 * the same socket descriptor is used for sending the Unicast UDP data.
129 * @param[in] socketFD Socket descriptor used for sending UDP data.
131 void CAIPSetUnicastSocket(int socketFD);
134 * Set the port number for sending unicast UDP data.
135 * @param[in] port Port number used for sending UDP data.
137 void CAIPSetUnicastPort(uint16_t port);
140 * API to send unicast UDP data.
142 * @param[in] endpoint complete network address to send to.
143 * @param[in] data Data to be send.
144 * @param[in] dataLength Length of data in bytes.
145 * @param[in] isMulticast Whether data needs to be sent to multicast ip.
147 void CAIPSendData(CAEndpoint_t *endpoint,
153 * Get IP adapter connection state.
155 * @return True if IP adapter is connected, otherwise false.
157 bool CAIPIsConnected();
160 * Pull the Received Data.
165 #define CA_SECURE_COAP 5684
168 * Let the network monitor update the polling interval.
169 * @param [in] current polling interval
171 * @return desired polling interval
173 int CAGetPollingInterval(int interval);
176 * Set callback for error handling.
178 * @param[in] errorHandleCallback callback to notify error to the ipadapter.
180 void CAIPSetErrorHandler(CAIPErrorHandleCallback errorHandleCallback);
183 * Set udp multicast time to live value to control the scope of the multicasts.
184 * @param[in] ttl To be set to any value from 0 to 255.
186 * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
188 CAResult_t CAIPSetMulticastTTL(size_t ttl);
191 * Get udp multicast time to live value.
192 * @param[out] ttl TTL pointer to get the stored multicast time to live.
194 * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
196 CAResult_t CAIPGetMulticastTTL(size_t *ttl);
199 * Create multicast socket to receive multicast message from remote device.
201 void CreateMulticastSocket();
204 * Close multicast socket to stop receiving multicast message.
206 void CloseMulticastSocket();
211 #endif /* CA_IP_INTERFACE_H_ */