Merge branch 'security-CKM' into 'master'

[platform/upstream/iotivity.git] / resource / csdk / connectivity / inc / canetworkconfigurator.h

diff --git a/resource/csdk/connectivity/inc/canetworkconfigurator.h b/resource/csdk/connectivity/inc/canetworkconfigurator.h
index 38eea6c..775c516 100644 (file)
--- a/resource/csdk/connectivity/inc/canetworkconfigurator.h
+++ b/resource/csdk/connectivity/inc/canetworkconfigurator.h
@@ -1,4 +1,4 @@
-/******************************************************************
+/* ****************************************************************
  *
  * Copyright 2014 Samsung Electronics All Rights Reserved.
  *
@@ -17,8 +17,15 @@
  * limitations under the License.
  *
  ******************************************************************/
-#ifndef _NETWORK_CONFIGURATOR_H_
-#define _NETWORK_CONFIGURATOR_H_
+
+/**
+ * @file
+ *
+ * This file contains  utility function for network configurations.
+ */
+
+#ifndef NETWORK_CONFIGURATOR_H_
+#define NETWORK_CONFIGURATOR_H_
 
 #include "cacommon.h"
 #include "uarraylist.h"
@@ -28,21 +35,44 @@ extern "C"
 {
 #endif
 
-static uint32_t NETWORK_ETHERNET = CA_ETHERNET;
-static uint32_t NETWORK_WIFI = CA_WIFI;
-static uint32_t NETWORK_EDR = CA_EDR;
-static uint32_t NETWORK_LE = CA_LE;
+/**
+ * Add network type to the selected networks for network packets reception.
+ * @param[in]   transportAdapter      Adapter that needs to be added.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CAAddNetworkType(CATransportAdapter_t transportAdapter);
 
-CAResult_t CAAddNetworkType(uint32_t CAConnectivityType);
+/**
+ * Remove network type from the selected configuration.
+ * @param[in]   transportAdapter       Adapter that needs to be removed.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CARemoveNetworkType(CATransportAdapter_t transportAdapter);
 
-CAResult_t CARemoveNetworkType(uint32_t CAConnectivityType);
+/**
+ * Get selected network information.
+ * @return array list having the connectivity types.
+ */
+u_arraylist_t *CAGetSelectedNetworkList();
 
-u_arraylist_t* CAGetSelectedNetworkList();
+/**
+ * Get network informations of the selected networks.
+ * @param[out]   info       LocalConnectivity objects.
+ * @param[out]   size       No Of Array objects.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CAGetNetworkInformationInternal(CAEndpoint_t **info, uint32_t *size);
+
+/**
+ * Terminate network type from selected configuration.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CATerminateNetworkType();
 
-CAResult_t CAGetNetworkInformationInternal(CALocalConnectivity_t **info, uint32_t* size);
 
 #ifdef __cplusplus
 } /* extern "C" */
 #endif
 
-#endif //#ifndef _NETWORK_CONFIGURATOR_H_
+#endif /* NETWORK_CONFIGURATOR_H_ */
+