1 /* *****************************************************************
3 * Copyright 2015 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 ******************************************************************/
23 * This file provides APIs TCP client/server/network monitor modules.
26 #ifndef CA_TCP_INTERFACE_H_
27 #define CA_TCP_INTERFACE_H_
32 #include "catcpadapter.h"
33 #include "cathreadpool.h"
34 #include "uarraylist.h"
42 * Callback to be notified on reception of any data from remote OIC devices.
44 * @param[in] endpoint network endpoint description.
45 * @param[in] data Data received from remote OIC device.
46 * @param[in] dataLength Length of data in bytes.
47 * @pre Callback must be registered using CAIPSetPacketReceiveCallback().
49 typedef void (*CATCPPacketReceivedCallback)(const CASecureEndpoint_t *endpoint,
54 * Callback to notify error in the TCP adapter.
56 * @param[in] endpoint network endpoint description.
57 * @param[in] data Data sent/received.
58 * @param[in] dataLength Length of data in bytes.
59 * @param[in] result result of request from R.I.
60 * @pre Callback must be registered using CAIPSetPacketReceiveCallback().
62 typedef void (*CATCPErrorHandleCallback)(const CAEndpoint_t *endpoint, const void *data,
63 uint32_t dataLength, CAResult_t result);
66 * Callback to notify connection information in the TCP adapter.
68 * @param[in] addr connected device address.
69 * @param[in] port connected port info.
70 * @param[in] isConnected Whether keepalive message needs to be sent.
71 * @see Callback must be registered using CATCPSetKeepAliveCallback().
73 typedef void (*CATCPKeepAliveHandleCallback)(const char *addr, uint16_t port, bool isConnected);
76 * set error callback to notify error in TCP adapter.
78 * @param[in] errorHandleCallback Callback function to notify the error
81 void CATCPSetErrorHandler(CATCPErrorHandleCallback errorHandleCallback);
84 * set keepalive callback to notify connection information in TCP adapter.
86 * @param[in] keepaliveHandler Callback function to notify the connection information.
89 void CATCPSetKeepAliveCallback(CATCPKeepAliveHandleCallback keepaliveHandler);
94 * @param threadPool Thread pool for managing Unicast server threads.
95 * @return ::CA_STATUS_OK or Appropriate error code.
96 * @retval ::CA_STATUS_OK Successful.
97 * @retval ::CA_STATUS_INVALID_PARAM Invalid input data.
98 * @retval ::CA_STATUS_FAILED Initialization failed.
100 CAResult_t CATCPStartServer(const ca_thread_pool_t threadPool);
105 void CATCPStopServer();
108 * Set this callback for receiving data packets from peer devices.
110 * @param[in] callback Callback to be notified on reception of unicast data packets.
112 void CATCPSetPacketReceiveCallback(CATCPPacketReceivedCallback callback);
115 * API to send unicast TCP data.
117 * @param[in] endpoint complete network address to send to.
118 * @param[in] data Data to be send.
119 * @param[in] dataLength Length of data in bytes.
120 * @param[in] isMulticast Whether data needs to be sent to multicast ip.
122 void CATCPSendData(CAEndpoint_t *endpoint, const void *data, uint32_t dataLength,
126 * Get a list of CAInterface_t items.
128 * @return List of CAInterface_t items.
130 u_arraylist_t *CATCPGetInterfaceInformation(int desiredIndex);
133 * Connect to TCP Server.
135 * @param[in] endpoint remote endpoint information.
136 * @return TCP Session Information structure.
138 CATCPSessionInfo_t *CAConnectTCPSession(const CAEndpoint_t *endpoint);
141 * Disconnect from TCP Server.
143 * @param[in] svritem TCP session information.
144 * @param[in] index current session index in list.
145 * @return ::CA_STATUS_OK or Appropriate error code.
147 CAResult_t CADisconnectTCPSession(CATCPSessionInfo_t *svritem, size_t index);
150 * Disconnect all connection from TCP Server.
152 void CATCPDisconnectAll();
155 * Get TCP connection information from list.
157 * @param[in] endpoint remote endpoint information.
158 * @param[out] index index of array list.
159 * @return TCP Session Information structure.
161 CATCPSessionInfo_t *CAGetTCPSessionInfoFromEndpoint(const CAEndpoint_t *endpoint,
165 * Get total length from CoAP over TCP header.
167 * @param[in] recvBuffer received header data.
168 * @return total data length
170 size_t CAGetTotalLengthFromHeader(const unsigned char *recvBuffer);
173 * Get session information from file descriptor index.
175 * @param[in] fd file descriptor.
176 * @param[out] index index of array list
177 * @return TCP Server Information structure.
179 CATCPSessionInfo_t *CAGetSessionInfoFromFD(int fd, size_t *index);
185 #endif /* CA_TCP_INTERFACE_H_ */