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 contains the APIs for TCP Adapter.
25 #ifndef CA_TCP_ADAPTER_H_
26 #define CA_TCP_ADAPTER_H_
29 #include "caadapterinterface.h"
30 #include "cathreadpool.h"
31 #include "cainterface.h"
40 * TCP Session Information for IPv4 TCP transport
44 CASecureEndpoint_t sep; /**< secure endpoint information */
45 int fd; /**< file descriptor info */
46 void *recvData; /**< received data from remote device*/
47 size_t recvDataLen; /**< received data length */
48 size_t totalDataLen; /**< total data length */
52 * API to initialize TCP Interface.
53 * @param[in] registerCallback Callback to register TCP interfaces to
54 * Connectivity Abstraction Layer.
55 * @param[in] networkPacketCallback Callback to notify request and
56 * response messages from server(s)
57 * started at Connectivity Abstraction Layer.
58 * @param[in] netCallback Callback to notify the adapter changes
59 * to Connectivity Abstraction Layer.
60 * @param[in] connCallback Callback to notify the connection changes
61 * to Connectivity Abstraction Layer.
62 * @param[in] errorCallback Callback to notify the network errors to
63 * Connectivity Abstraction Layer.
64 * @param[in] handle Threadpool Handle.
65 * @return ::CA_STATUS_OK or Appropriate error code
67 CAResult_t CAInitializeTCP(CARegisterConnectivityCallback registerCallback,
68 CANetworkPacketReceivedCallback networkPacketCallback,
69 CAAdapterChangeCallback netCallback,
70 CAConnectionChangeCallback connCallback,
71 CAErrorHandleCallback errorCallback, ca_thread_pool_t handle);
74 * Start TCP Interface adapter.
75 * @return ::CA_STATUS_OK or Appropriate error code.
77 CAResult_t CAStartTCP();
80 * Start listening server for receiving connect requests.
81 * Transport Specific Behavior:
82 * TCP Starts Listening Server on a particular interface and prefixed port
83 * number and as per OIC Specification.
84 * @return ::CA_STATUS_OK or Appropriate error code.
86 CAResult_t CAStartTCPListeningServer();
89 * Stops listening server from receiving connect requests.
90 * Transport Specific Behavior:
91 * TCP Stops Listening Server on a particular interface and prefixed port
92 * number and as per OIC Specification.
93 * @return ::CA_STATUS_OK or Appropriate error code.
95 CAResult_t CAStopTCPListeningServer();
98 * Start discovery servers for receiving advertisements.
99 * Transport Specific Behavior:
100 * TCP Starts Discovery server on a particular interface and prefixed port
101 * number as per OIC Specification.
102 * @return ::CA_STATUS_OK or Appropriate error code.
104 CAResult_t CAStartTCPDiscoveryServer();
107 * Sends data to the endpoint using the adapter connectivity.
108 * @param[in] endpoint Remote Endpoint information (like ipaddress,
109 * port, reference uri and transport type) to
110 * which the unicast data has to be sent.
111 * @param[in] data Data which is required to be sent.
112 * @param[in] dataLen Size of data to be sent.
113 * @param[in] dataType Data type which is REQUEST or RESPONSE.
114 * @note dataLen must be > 0.
115 * @return The number of bytes sent on the network, or -1 upon error.
117 int32_t CASendTCPUnicastData(const CAEndpoint_t *endpoint,
118 const void *data, uint32_t dataLen,
119 CADataType_t dataType);
122 * Send Multicast data to the endpoint using the TCP connectivity.
123 * @param[in] endpoint Remote Endpoint information (like ipaddress,
125 * @param[in] data Data which is required to be sent.
126 * @param[in] dataLen Size of data to be sent.
127 * @param[in] dataType Data type which is REQUEST or RESPONSE.
128 * @note dataLen must be > 0.
129 * @return The number of bytes sent on the network, or -1 upon error.
131 int32_t CASendTCPMulticastData(const CAEndpoint_t *endpoint,
132 const void *data, uint32_t dataLen,
133 CADataType_t dataType);
136 * Get TCP Connectivity network information.
137 * @param[out] info Local connectivity information structures.
138 * @note info is allocated in this API and should be freed by the caller.
139 * @param[out] size Number of local connectivity structures.
140 * @return ::CA_STATUS_OK or Appropriate error code.
142 CAResult_t CAGetTCPInterfaceInformation(CAEndpoint_t **info, uint32_t *size);
145 * Read Synchronous API callback.
146 * @return ::CA_STATUS_OK or Appropriate error code.
148 CAResult_t CAReadTCPData();
151 * Stops Unicast, servers and close the sockets.
152 * @return ::CA_STATUS_OK or Appropriate error code.
154 CAResult_t CAStopTCP();
157 * Terminate the TCP connectivity adapter.
158 * Configuration information will be deleted from further use.
160 void CATerminateTCP();
163 * Set connection status changes callback to process KeepAlive.
164 * connection informations are delivered these callbacks.
165 * @param[in] ConnHandler Connection status changes callback.
167 void CATCPSetKeepAliveCallbacks(CAKeepAliveConnectionCallback ConnHandler);
173 #endif // CA_TCP_ADAPTER_H_