Modified to return an exception(E_INVALID_STATE) when you try to connect to a speicif...

[framework/osp/net.git] / src / inc / FNetWifi_WifiUtility.h

diff --git a/src/inc/FNetWifi_WifiUtility.h b/src/inc/FNetWifi_WifiUtility.h
index 2a37aeb..0599225 100644 (file)
--- a/src/inc/FNetWifi_WifiUtility.h
+++ b/src/inc/FNetWifi_WifiUtility.h
@@ -84,8 +84,8 @@ public:
         * Converts wlan_security_mode_type_t to WifiAuthentication Type
         *
         * @return       WifiAuthenticationType
-        * @param[in]   securityMode         Security Mode
-        * @param[in]   encType              Encryption Type
+        * @param[in]   securityMode        Security Mode
+        * @param[in]   encType             Encryption Type
         */
        static WifiAuthenticationType ConvertAuthType(wifi_security_type_e securityMode, wifi_encryption_type_e encType);
 
@@ -93,7 +93,7 @@ public:
        * Converts WifiAuthenticationType to wifi_security_type_e
        *
        * @return       wifi_security_type_e
-       * @param[in]   authMode         Authentication Mode
+       * @param[in]   authMode             Authentication Mode
        */
 
        static wifi_security_type_e ConvertSecurityType(WifiAuthenticationType authMode);
@@ -101,7 +101,7 @@ public:
         * Converts frequency to RadioChannel.
         *
         * @return       WifiRadioChannel
-        * @param[in]    frequency           radio frequency value
+        * @param[in]    frequency          radio frequency value
         */
        static WifiRadioChannel ConvertRadioChannel(int frequency);
 
@@ -109,7 +109,7 @@ public:
         * Converts Rssi value from level
         *
         * @return       long
-        * @param[in]    val                 rssi value
+        * @param[in]    val                rssi value
         */
        static long ConvertLeveltoRssiValue(wifi_rssi_level_e val);
 
@@ -117,7 +117,7 @@ public:
         * Converts Rssi value from percentage
         *
         * @return       long
-        * @param[in]    val                 Rssi percentage value
+        * @param[in]    val                Rssi percentage value
         */
        static long ConvertPercentagetoRssiValue(char val);
 
@@ -126,7 +126,7 @@ public:
         * Converts Encryption Type
         *
         * @return       WifiEncryptionType
-        * @param[in]    encType             Encryption Type
+        * @param[in]    encType            Encryption Type
         */
        static WifiEncryptionType ConvertEncryptionType(wifi_encryption_type_e encType);
 
@@ -134,7 +134,7 @@ public:
         * Converts Encryption Type
         *
         * @return       wifi_encryption_type_e
-        * @param[in]    encryptionMode       Encryption Type
+        * @param[in]    encryptionMode     Encryption Type
         */
        static wifi_encryption_type_e ConvertEncryptionType(WifiEncryptionType encryptionMode);
 
@@ -142,8 +142,8 @@ public:
         * Converts EAP Type
         *
         * @return       WifiEapType
-        * @param[in]    eapType             EAP Type
-        * @param[in]    eapAuthType         EAP authentication type
+        * @param[in]    eapType            EAP Type
+        * @param[in]    eapAuthType        EAP authentication type
         */
        static WifiEapType ConvertEapType(wifi_eap_type_e eapType, wifi_eap_auth_type_e eapAuthType);
 
@@ -151,7 +151,7 @@ public:
         * Converts EAP Type
         *
         * @return       wlan_eap_type_t
-        * @param[in]    eapType             EAP Type
+        * @param[in]    eapType            EAP Type
         */
        static wifi_eap_type_e ConvertEapType(WifiEapType eapType);
 
@@ -159,7 +159,7 @@ public:
         * Converts EAP Authentication Type
         *
         * @return       wlan_eap_auth_type_t
-        * @param[in]    eapType         EAP authentication type
+        * @param[in]    eapType            EAP authentication type
         */
        static wifi_eap_auth_type_e ConvertEapAuthType(WifiEapType eapype);
 
@@ -167,38 +167,51 @@ public:
         * Converts Mac Address
         *
         * @return       String
-        * @param[in]    macAddress          mac address
+        * @param[in]    macAddress         mac address
         */
        static Tizen::Base::String ConvertMacAddress(char macAddress[]);
 
        /**
+        * Gets BSS ID from handle of access point
+        *
+        * @return       String
+        * @param[in]    pApHandle          A handle of access point
+        *
+        */
+       static Tizen::Base::String GetBssIdFromApHandle(wifi_ap_h pApHandle);
+
+       /**
         * Converts profile info to bssinfo
         *
         * @return       WifiBssInfo        bss information
-        * @param[in]    apHandler          Access Point Handler
+        * @param[in]    pApHandle          A handle of access point
         */
-       static WifiBssInfo* CreateWifiBssInfoInstanceN(wifi_ap_h& apHandler);
+       static WifiBssInfo* CreateWifiBssInfoInstanceN(wifi_ap_h& pApHandle);
 
        /**
         * Releases memory for wifi aphandler and sets it to null
         *
-        * @param[in]    apHandler          Access Point Handler
+        * @param[in]    pDestHandle        The destination handle of access point
+        * @param[in]    pSrcHandle         The source handle of access point
         */
-       static void WifiApClone(void** pDest, void* pSrc);
+       static void WifiApClone(void*& pDestHandle, void* pSrcHandle);
 
        /**
         * Clones access point handler
         *
-        * @param[in]    apHandler          Access Point Handler
+        * @param[in]    apHandler          A handle of access point
         */
-       static void WifiApDestory(void** pApHandler);
+       static void WifiApDestory(void*& pApHandler);
 
        /**
         * Checks whether the values of the two %IpAddress objects are equal.
         */
        static bool CheckAddressEquality(Tizen::Net::IpAddress* pFirstAddress, Tizen::Net::IpAddress* pSecondAddress);
 
-    static Tizen::Base::Collection::IList* GetWifiBssInfoListCloneN(const Tizen::Base::Collection::IList* pSrcList);
+       /**
+        * Gets the copy of list of WifiBssInfo.
+        */
+       static Tizen::Base::Collection::IList* GetWifiBssInfoListCloneN(const Tizen::Base::Collection::IList* pSrcList);
 
 private:
        /**