-/******************************************************************
+//*****************************************************************
//
// Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
-******************************************************************/
+//****************************************************************
/**
* @file caraadapter.h
- * @brief This file contains the APIs for IP Adapter.
+ * This file contains the APIs for IP Adapter.
*/
#ifndef CA_RA_ADAPTER_H_
#define CA_RA_ADAPTER_H_
#include "cacommon.h"
#include "caadapterinterface.h"
+#include "cainterface.h"
#include "cathreadpool.h"
#ifdef __cplusplus
/**
- * @brief API to initialize RA Interface.
- * @param registerCallback [IN] Callback to register RA interfaces to Connectivity
- * Abstraction Layer
- * @param networkPacketCallback [IN] Callback to notify request and response messages from server(s)
+ * API to initialize RA Interface.
+ * @param[in] registerCallback Callback to register RA interfaces to
+ * Connectivity Abstraction Layer.
+ * @param[in] networkPacketCallback Callback to notify request and
+ * response messages from server(s)
* started at Connectivity Abstraction Layer.
- * @param netCallback [IN] Callback to notify the network additions to Connectivity
- * Abstraction Layer.
- * @param handle [IN] Threadpool Handle
- * @return #CA_STATUS_OK or Appropriate error code
+ * @param[in] netCallback Callback to notify the network
+ * additions to Connectivity Abstraction
+ * Layer.
+ * @param[in] handle Threadpool Handle.
+ * @return ::CA_STATUS_OK or Appropriate error code.
*/
CAResult_t CAInitializeRA(CARegisterConnectivityCallback registerCallback,
CANetworkPacketReceivedCallback networkPacketCallback,
/**
- * @brief Start RA Interface adapter.
- * @return #CA_STATUS_OK or Appropriate error code
+ * Start RA Interface adapter.
+ * @return ::CA_STATUS_OK or Appropriate error code.
*/
CAResult_t CAStartRA();
/**
- * @brief Sends data to the endpoint using the adapter connectivity.
- * @param endpoint [IN] Remote Endpoint information (like ipaddress , port,
- * reference uri and transport type) to which the unicast data has to be sent.
- * @param data [IN] Data which is required to be sent.
- * @param dataLen [IN] Size of data to be sent.
- * @return The number of bytes sent on the network. Return value equal to -1 indicates error.
- * @remarks dataLen must be > 0.
+ * Sends data to the endpoint using the adapter connectivity.
+ * @param[in] endpoint Remote Endpoint information (like ipaddress, port,
+ * reference uri and transport type) to which
+ * the unicast data has to be sent.
+ * @param[in] data Data which is required to be sent.
+ * @param[in] dataLen Size of data to be sent.
+ * @note dataLen must be > 0.
+ * @return The number of bytes sent on the network, or -1 upon error.
*/
int32_t CASendRAUnicastData(const CAEndpoint_t *endpoint, const void *data,
uint32_t dataLen);
/**
- * @brief Get RA Connectivity network information
- * @param info [OUT] Local connectivity information structures
- * @param size [OUT] Number of local connectivity structures.
- * @return #CA_STATUS_OK or Appropriate error code
- * @remarks info is allocated in this API and should be freed by the caller.
+ * Get RA Connectivity network information.
+ * @param[out] info Local connectivity information structures.
+ * @note info is allocated in this API and should be freed by the caller.
+ * @param[out] size Number of local connectivity structures.
+ * @return ::CA_STATUS_OK or Appropriate error code.
*/
CAResult_t CAGetRAInterfaceInformation(CAEndpoint_t **info, uint32_t *size);
/**
- * @brief Stops RA server and de-register XMPP callback listeners
- * @return #CA_STATUS_OK or Appropriate error code
+ * Stops RA server and de-register XMPP callback listeners.
+ * @return ::CA_STATUS_OK or Appropriate error code.
*/
CAResult_t CAStopRA();
/**
- * @brief Terminate the RA connectivity adapter.
- * Configuration information will be deleted from further use
- * @return NONE
+ * Terminate the RA connectivity adapter.
+ * Configuration information will be deleted from further use.
*/
void CATerminateRA();
/**
- * @brief Set Remote Access information for XMPP Client.
- * @param caraInfo [IN] remote access info.
+ * Set Remote Access information for XMPP Client.
+ * @param[in] caraInfo remote access info.
*
- * @return CA_STATUS_OK
+ * @return ::CA_STATUS_OK.
*/
CAResult_t CASetRAInfo(const CARAInfo_t *caraInfo);
/**
- * These functions are not applicable to Remote Access adapter
+ * These functions are not applicable to Remote Access adapter.
*/
int32_t CASendRAMulticastData(const CAEndpoint_t *endpoint,
const void *data, uint32_t dataLen);
+
/**
- * @brief Start listening server for receiving search requests.
- * @return #CA_NOT_SUPPORTED
+ * Start listening server for receiving search requests.
+ * @return ::CA_NOT_SUPPORTED.
*/
CAResult_t CAStartRAListeningServer();
/**
- * @brief Start discovery servers for receiving advertisements.
- * @return #CA_NOT_SUPPORTED
+ * Stops listening server from receiving search requests.
+ * @return ::CA_NOT_SUPPORTED.
+ */
+CAResult_t CAStopRAListeningServer();
+
+/**
+ * Start discovery servers for receiving advertisements.
+ * @return ::CA_NOT_SUPPORTED.
*/
CAResult_t CAStartRADiscoveryServer();
/**
- * @brief Read Synchronous API callback.
- * @return #CA_NOT_SUPPORTED
+ * Read Synchronous API callback.
+ * @return ::CA_NOT_SUPPORTED.
*/
CAResult_t CAReadRAData();
#endif
#endif //CA_RA_ADAPTER_H_
-
projects / platform / upstream / iotivity.git / blobdiff