Use `URI` all caps in documentation
[iotivity.git] / resource / csdk / connectivity / api / cainterface.h
index 70c15a9..1dd7039 100644 (file)
@@ -68,8 +68,11 @@ typedef struct
 /**
  * Callback function to pass the connection information from CA to RI.
  * @param[out]   object           remote device information.
+ * @param[out]   isConnected      Whether keepalive message needs to be sent.
+ * @param[out]   isClient         Host Mode of Operation.
  */
-typedef void (*CAKeepAliveConnectionCallback)(const CAEndpoint_t *object, bool isConnected);
+typedef void (*CAKeepAliveConnectionCallback)(const CAEndpoint_t *object, bool isConnected,
+                                              bool isClient);
 
 /**
  * Register connection status changes callback to process KeepAlive.
@@ -82,16 +85,16 @@ void CARegisterKeepAliveHandler(CAKeepAliveConnectionCallback ConnHandler);
  * Initialize the connectivity abstraction module.
  * It will initialize adapters, thread pool and other modules based on the platform
  * compilation options.
- *
+ * @param[in]   transportType  transport type to initialize.
  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED
  */
-CAResult_t CAInitialize();
+CAResult_t CAInitialize(CATransportAdapter_t transportType);
 
 /**
  * Terminate the connectivity abstraction module.
  * All threads, data structures are destroyed for next initializations.
  */
-void CATerminate();
+void CATerminate(void);
 
 /**
  * Starts listening servers.
@@ -99,14 +102,14 @@ void CATerminate();
  * Based on the adapters configurations, different kinds of servers are started.
  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED
  */
-CAResult_t CAStartListeningServer();
+CAResult_t CAStartListeningServer(void);
 
 /**
  * Stops the server from receiving the multicast traffic. This is used by sleeping
  * device to not receives the multicast traffic.
  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED
  */
-CAResult_t CAStopListeningServer();
+CAResult_t CAStopListeningServer(void);
 
 /**
  * Starts discovery servers.
@@ -114,7 +117,7 @@ CAResult_t CAStopListeningServer();
  * Based on the adapters configurations, different kinds of servers are started.
  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED
  */
-CAResult_t CAStartDiscoveryServer();
+CAResult_t CAStartDiscoveryServer(void);
 
 /**
  * Register request callbacks and response callbacks.
@@ -213,20 +216,20 @@ CAResult_t CAUnSelectNetwork(CATransportAdapter_t nonInterestedNetwork);
  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED or
  *          ::CA_STATUS_INVALID_PARAM or ::CA_MEMORY_ALLOC_FAILED
  */
-CAResult_t CAGetNetworkInformation(CAEndpoint_t **info, uint32_t *size);
+CAResult_t CAGetNetworkInformation(CAEndpoint_t **info, size_t *size);
 
 /**
  * Get supported network adapter.
  *
  * @return  Bit combinations of CATransportAdapter_t enumeration which indicate enabled adapter.
  */
-CATransportAdapter_t CAGetSelectedNetwork();
+CATransportAdapter_t CAGetSelectedNetwork(void);
 
 /**
  * To Handle the Request or Response.
  * @return   ::CA_STATUS_OK or ::CA_STATUS_NOT_INITIALIZED
  */
-CAResult_t CAHandleRequestResponse();
+CAResult_t CAHandleRequestResponse(void);
 
 #ifdef RA_ADAPTER
 /**
@@ -239,14 +242,26 @@ CAResult_t CASetRAInfo(const CARAInfo_t *caraInfo);
 #endif
 
 /**
- * This function sets uri being used for proxy.
+ * This function sets URI being used for proxy.
  *
- * @param uri            NULL terminated resource uri for CoAP-HTTP Proxy.
+ * @param uri            NULL terminated resource URI for CoAP-HTTP Proxy.
  *
  * @return  ::CA_STATUS_OK or ::CA_STATUS_INVALID_PARAM
  */
 CAResult_t CASetProxyUri(const char *uri);
 
+#ifdef IP_ADAPTER
+/**
+ * This function return zone id related from ifindex and address.
+ *
+ * @param[in] ifindex     interface index.
+ * @param[out] zoneId     pointer of zoneId string.
+ *
+ * @return  ::CA_STATUS_OK or ::CA_STATUS_INVALID_PARAM
+ */
+CAResult_t CAGetLinkLocalZoneId(uint32_t ifindex, char **zoneId);
+#endif
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif