Corrected @file tags and restored 'Files' section.
[platform/upstream/iotivity.git] / resource / csdk / connectivity / inc / caedradapter_singlethread.h
index 88335ab..5648726 100644 (file)
@@ -1,4 +1,4 @@
-/******************************************************************
+/* ****************************************************************
  *
  * Copyright 2014 Samsung Electronics All Rights Reserved.
  *
  * limitations under the License.
  *
  ******************************************************************/
+
 /**
- * @file  caedradapter_singlethread.h
- * @brief This file contains the APIs for EDR adapters to be implemented
+ * @file
+ *
+ * This file contains the APIs for EDR adapters to be implemented.
  */
+
 #ifndef __CA_EDRADAPTER_SINGLETHREAD_H_
 #define __CA_EDRADAPTER_SINGLETHREAD_H_
 
@@ -41,7 +44,7 @@ extern "C"
  *                                Abstraction Layer
  * @param  reqRespCallback   [IN] Callback to notify request and response messages from server(s)
  *                                started at Connectivity Abstraction Layer.
- * @param  netCallback       [IN] Callback to intimate the network additions to Connectivity
+ * @param  netCallback       [IN] Callback to notify the network additions to Connectivity
  *                                Abstraction Layer.
  * @return #CA_STATUS_OK or Appropriate error code
  * @retval #CA_STATUS_OK Successful
@@ -92,9 +95,9 @@ CAResult_t CAStartEDRDiscoveryServer();
  *                              connectivity type) to which the unicast data has to be sent.
  * @param  data            [IN] Data to be sent.
  * @param  dataLength      [IN] Size of data to be sent.
- * @return Number of bytes sent on the network. Returns 0 on error.
+ * @return Number of bytes sent on the network. Returns -1 on error.
  */
-uint32_t CASendEDRUnicastData(const CARemoteEndpoint_t *remoteEndpoint, void *data,
+int32_t CASendEDRUnicastData(const CARemoteEndpoint_t *remoteEndpoint, const void *data,
                               uint32_t dataLength);
 
 /**
@@ -102,9 +105,9 @@ uint32_t CASendEDRUnicastData(const CARemoteEndpoint_t *remoteEndpoint, void *da
  *         connectivity.
  * @param  data         [IN]  Data which needs to be sent to all discovered bluetooth OIC device.
  * @param  dataLength   [IN]  Length of data in bytes.
- * @return Number of bytes sent on the network. Returns 0 on error.
+ * @return Number of bytes sent on the network. Returns -1 on error.
  */
-uint32_t CASendEDRMulticastData(void *data, uint32_t dataLength);
+int32_t CASendEDRMulticastData(const void *data, uint32_t dataLength);
 
 /**
  * @brief  Get EDR Connectivity network information.
@@ -147,3 +150,4 @@ void CATerminateEDR();
 #endif
 
 #endif  //__CA_EDRADAPTER_SINGLETHREAD_H_
+