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 /**
  83  * set keepalive callback to notify connection information in TCP adapter.
  84  *
  85  * @param[in]  keepaliveHandler Callback function to notify the connection information.
  86  * in the TCP adapter.
  87  */
  88 void CATCPSetKeepAliveCallback(CAKeepAliveConnectionCallback keepaliveHandler);
  89
  90 /**
  91  * Start TCP server.
  92  *
  93  * @param   threadPool   Thread pool for managing Unicast server threads.
  94  * @return ::CA_STATUS_OK or Appropriate error code.
  95  * @retval ::CA_STATUS_OK  Successful.
  96  * @retval ::CA_STATUS_INVALID_PARAM Invalid input data.
  97  * @retval ::CA_STATUS_FAILED Initialization failed.
  98  */
  99 CAResult_t CATCPStartServer(const ca_thread_pool_t threadPool);
 100
 101 /**
 102  * Stop TCP server.
 103  */
 104 void CATCPStopServer();
 105
 106 /**
 107  * Set this callback for receiving data packets from peer devices.
 108  *
 109  * @param[in]  callback    Callback to be notified on reception of unicast data packets.
 110  */
 111 void CATCPSetPacketReceiveCallback(CATCPPacketReceivedCallback callback);
 112
 113 /**
 114  * API to send unicast TCP data.
 115  *
 116  * @param[in]  endpoint          complete network address to send to.
 117  * @param[in]  data              Data to be send.
 118  * @param[in]  dataLength        Length of data in bytes.
 119  * @param[in]  isMulticast       Whether data needs to be sent to multicast ip.
 120  */
 121 void CATCPSendData(CAEndpoint_t *endpoint, const void *data, uint32_t dataLength,
 122                    bool isMulticast);
 123
 124 /**
 125  * Get a list of CAInterface_t items.
 126  *
 127  * @return  List of CAInterface_t items.
 128  */
 129 u_arraylist_t *CATCPGetInterfaceInformation(int desiredIndex);
 130
 131 /**
 132  * Connect to TCP Server.
 133  *
 134  * @param[in]   endpoint    remote endpoint information.
 135  * @return  TCP Session Information structure.
 136  */
 137 CATCPSessionInfo_t *CAConnectTCPSession(const CAEndpoint_t *endpoint);
 138
 139 /**
 140  * Disconnect from TCP Server.
 141  *
 142  * @param[in]   svritem     TCP session information.
 143  * @param[in]   index       current session index in list.
 144  * @return  ::CA_STATUS_OK or Appropriate error code.
 145  */
 146 CAResult_t CADisconnectTCPSession(CATCPSessionInfo_t *svritem, size_t index);
 147
 148 /**
 149  * Disconnect all connection from TCP Server.
 150  */
 151 void CATCPDisconnectAll();
 152
 153 /**
 154  * Get TCP connection information from list.
 155  *
 156  * @param[in]   endpoint    remote endpoint information.
 157  * @param[out]  index   index of array list.
 158  * @return  TCP Session Information structure.
 159  */
 160 CATCPSessionInfo_t *CAGetTCPSessionInfoFromEndpoint(const CAEndpoint_t *endpoint,
 161                                                     size_t *index);
 162
 163 /**
 164  * Get total length from CoAP over TCP header.
 165  *
 166  * @param[in]   recvBuffer    received header data.
 167  * @return  total data length
 168  */
 169 size_t CAGetTotalLengthFromHeader(const unsigned char *recvBuffer);
 170
 171 /**
 172  * Get session information from file descriptor index.
 173  *
 174  * @param[in]   fd      file descriptor.
 175  * @param[out]  index   index of array list
 176  * @return  TCP Server Information structure.
 177  */
 178 CATCPSessionInfo_t *CAGetSessionInfoFromFD(int fd, size_t *index);
 179
 180 #ifdef __cplusplus
 181 }
 182 #endif
 183
 184 #endif /* CA_TCP_INTERFACE_H_ */