[ARDUINO] Resolved build error for WITH_TCP=TRUE
[platform/upstream/iotivity.git] / resource / csdk / connectivity / inc / catcpinterface.h
1 /* *****************************************************************
2  *
3  * Copyright 2015 Samsung Electronics All Rights Reserved.
4  *
5  *
6  *
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
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  ******************************************************************/
20
21 /**
22  * @file
23  * This file provides APIs TCP client/server/network monitor modules.
24  */
25
26 #ifndef CA_TCP_INTERFACE_H_
27 #define CA_TCP_INTERFACE_H_
28
29 #include <stdbool.h>
30
31 #include "cacommon.h"
32 #include "catcpadapter.h"
33 #include "cathreadpool.h"
34 #include "uarraylist.h"
35
36 #ifdef __cplusplus
37 extern "C"
38 {
39 #endif
40
41 /**
42  * Callback to be notified on reception of any data from remote OIC devices.
43  *
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().
48  */
49 typedef void (*CATCPPacketReceivedCallback)(const CASecureEndpoint_t *endpoint,
50                                             const void *data,
51                                             uint32_t dataLength);
52
53 /**
54   * Callback to notify error in the TCP adapter.
55   *
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().
61  */
62 typedef void (*CATCPErrorHandleCallback)(const CAEndpoint_t *endpoint, const void *data,
63                                          uint32_t dataLength, CAResult_t result);
64
65 /**
66   * Callback to notify connection information in the TCP adapter.
67   *
68   * @param[in]  endpoint        network endpoint description.
69   * @param[in]  isConnected     Whether keepalive message needs to be sent.
70   * @see  Callback must be registered using CATCPSetKeepAliveCallback().
71  */
72 typedef void (*CATCPConnectionHandleCallback)(const CAEndpoint_t *endpoint, bool isConnected);
73
74 /**
75  * set error callback to notify error in TCP adapter.
76  *
77  * @param[in]  errorHandleCallback Callback function to notify the error
78  * in the TCP adapter.
79  */
80 void CATCPSetErrorHandler(CATCPErrorHandleCallback errorHandleCallback);
81
82 #ifdef SINGLE_THREAD
83
84 CAResult_t CATCPStartServer();
85
86 /**
87  * Pull the Received Data.
88  */
89 void CATCPPullData();
90
91 /**
92  * Get TCP Header Details.
93  * @param[in]    recvBuffer   index of array list.
94  * @param[out]   transport    TCP Server address.
95  * @param[out]   headerlen    TCP Server port.
96  */
97 void CAGetTCPHeaderDetails(unsigned char *recvBuffer, coap_transport_type *transport,
98                            size_t *headerlen);
99
100 /**
101  * Get total length from CoAP over TCP header.
102  *
103  * @param[in]   recvBuffer    received header data.
104  * @param[in]   size          length of buffer.
105  * @return  total data length
106  */
107 size_t CAGetTotalLengthFromPacketHeader(const unsigned char *recvBuffer, size_t size);
108
109 #else
110 /**
111  * set keepalive callback to notify connection information in TCP adapter.
112  *
113  * @param[in]  keepaliveHandler Callback function to notify the connection information.
114  * in the TCP adapter.
115  */
116 void CATCPSetKeepAliveCallback(CAKeepAliveConnectionCallback keepaliveHandler);
117
118 /**
119  * Start TCP server.
120  *
121  * @param   threadPool   Thread pool for managing Unicast server threads.
122  * @return ::CA_STATUS_OK or Appropriate error code.
123  * @retval ::CA_STATUS_OK  Successful.
124  * @retval ::CA_STATUS_INVALID_PARAM Invalid input data.
125  * @retval ::CA_STATUS_FAILED Initialization failed.
126  */
127 CAResult_t CATCPStartServer(const ca_thread_pool_t threadPool);
128
129 #endif
130
131 /**
132  * Stop TCP server.
133  */
134 void CATCPStopServer();
135
136 /**
137  * Set this callback for receiving data packets from peer devices.
138  *
139  * @param[in]  callback    Callback to be notified on reception of unicast data packets.
140  */
141 void CATCPSetPacketReceiveCallback(CATCPPacketReceivedCallback callback);
142
143 /**
144  * Set this callback for receiving the changed connection information from peer devices.
145  *
146  * @param[in]  connHandler    Callback to be notified when connection state changes.
147  */
148 void CATCPSetConnectionChangedCallback(CATCPConnectionHandleCallback connHandler);
149
150 /**
151  * API to send unicast TCP data.
152  *
153  * @param[in]  endpoint          complete network address to send to.
154  * @param[in]  data              Data to be send.
155  * @param[in]  dataLength        Length of data in bytes.
156  * @param[in]  isMulticast       Whether data needs to be sent to multicast ip.
157  */
158 void CATCPSendData(CAEndpoint_t *endpoint, const void *data, uint32_t dataLength,
159                    bool isMulticast);
160
161 /**
162  * Get a list of CAInterface_t items.
163  *
164  * @return  List of CAInterface_t items.
165  */
166 u_arraylist_t *CATCPGetInterfaceInformation(int desiredIndex);
167
168 /**
169  * Connect to TCP Server.
170  *
171  * @param[in]   endpoint    remote endpoint information.
172  * @return  TCP Session Information structure.
173  */
174 CATCPSessionInfo_t *CAConnectTCPSession(const CAEndpoint_t *endpoint);
175
176 /**
177  * Disconnect from TCP Server.
178  *
179  * @param[in]   svritem     TCP session information.
180  * @param[in]   index       current session index in list.
181  * @return  ::CA_STATUS_OK or Appropriate error code.
182  */
183 CAResult_t CADisconnectTCPSession(CATCPSessionInfo_t *svritem, size_t index);
184
185 /**
186  * Disconnect all connection from TCP Server.
187  */
188 void CATCPDisconnectAll();
189
190 /**
191  * Get TCP connection information from list.
192  *
193  * @param[in]   endpoint    remote endpoint information.
194  * @param[out]  index   index of array list.
195  * @return  TCP Session Information structure.
196  */
197 CATCPSessionInfo_t *CAGetTCPSessionInfoFromEndpoint(const CAEndpoint_t *endpoint,
198                                                     size_t *index);
199
200 /**
201  * Get total length from CoAP over TCP header.
202  *
203  * @param[in]   recvBuffer    received header data.
204  * @return  total data length
205  */
206 size_t CAGetTotalLengthFromHeader(const unsigned char *recvBuffer);
207
208 /**
209  * Get session information from file descriptor index.
210  *
211  * @param[in]   fd      file descriptor.
212  * @param[out]  index   index of array list
213  * @return  TCP Server Information structure.
214  */
215 CATCPSessionInfo_t *CAGetSessionInfoFromFD(int fd, size_t *index);
216
217 #ifdef __cplusplus
218 }
219 #endif
220
221 #endif /* CA_TCP_INTERFACE_H_ */