* @remarks @b Header @b %file: @b \#include @b <FNet.h> @n
* @b Library : @b osp-wifi @n
*
- * The %Net::Wifi namespace contains the classes and interfaces for Wi-Fi management and Wi-Fi Direct functionalities. It provides a rich set of methods
- * to manage the Wi-Fi devices and accounts, and to communicate over a Wi-Fi channel. Additionally, the Wi-Fi Direct functionalities are provided to manage
- * the Wi-Fi Direct device, create a Wi-Fi Direct group, scan Wi-Fi Direct devices, associate to a Wi-Fi Direct group owner, get the WifiDirectGroupOwner or
- * the WifiDirectGroupClient instance, and allow the listener to get the events related to Wi-Fi Direct device and group.
+ * The %Net::Wifi namespace contains the classes and interfaces for Wi-Fi management and Wi-Fi Direct functionalities. It
+ * provides a rich set of methods to manage the Wi-Fi devices and accounts, and to communicate over a Wi-Fi channel.
+ * Additionally, the Wi-Fi Direct functionalities are provided to manage the Wi-Fi Direct device, create a Wi-Fi Direct group,
+ * scan Wi-Fi Direct devices, associate to a Wi-Fi Direct group owner, get the WifiDirectGroupOwner or the WifiDirectGroupClient
+ * instance, and allow the listener to get the events related to Wi-Fi Direct device and group.
*
- * This namespace provides the Wi-Fi and Wi-Fi Direct functionalities. The Wi-Fi related operations are provided by classes like WifiManager and WifiSecurityInfo.
- * The Wi-Fi Direct related operations are provided by classes like WifiDirectDevice.
+ * This namespace provides the Wi-Fi and Wi-Fi Direct functionalities. The Wi-Fi related operations are provided by classes like
+ * WifiManager and WifiSecurityInfo. The Wi-Fi Direct related operations are provided by classes like WifiDirectDevice.
*
- * For more information on the %Wifi namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a> and <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
+ * For more information on the %Wifi namespace features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a> and
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
*
* The following diagram illustrates the relationships between the Wi-Fi classes belonging to the %Wifi namespace.
* @image html net_wi-fi_using_the_apis_classdiagram.png
// limitations under the License.
//
/**
- * @file FNetWifiIWifiDirectDeviceListener.h
- * @brief This is the header file for the %IWifiDirectDeviceListener interface.
+ * @file FNetWifiIWifiDirectDeviceListener.h
+ * @brief This is the header file for the %IWifiDirectDeviceListener interface.
*
* This header file contains the declarations of the %IWifiDirectDeviceListener interface.
*/
*
* The %IWifiDirectDeviceListener interface represents a listener to get the Wi-Fi Direct device status or information.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
*/
class _OSP_EXPORT_ IWifiDirectDeviceListener
* This polymorphic destructor should be overridden if required. This way,
* the destructors of the derived classes are called when the destructor of this interface is called.
*
- * @since 2.0
+ * @since 2.0
*/
virtual ~IWifiDirectDeviceListener(void) {}
/**
* Called to notify the application that the local Wi-Fi Direct mode is enabled.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] localDeviceId The ID of the Wi-Fi Direct device
- * @param[in] r An error code
- * @exception E_SUCCESS The activation is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] localDeviceId The ID of the Wi-Fi Direct device
+ * @param[in] r An error code
+ * @exception E_SUCCESS The activation is successful.
+ * @exception E_SYSTEM A system error has occurred.
* @see WifiDirectDevice::Activate()
*/
virtual void OnWifiDirectDeviceActivated(WifiDirectDeviceId localDeviceId, result r) = 0;
/**
* Called to notify the application that the local Wi-Fi Direct mode is disabled.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] localDeviceId An ID for a Wi-Fi Direct device
* @param[in] r An error code
- * @exception E_SUCCESS The deactivation is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The deactivation is successful.
+ * @exception E_SYSTEM A system error has occurred.
* @see WifiDirectDevice::Deactivate()
*/
virtual void OnWifiDirectDeviceDeactivated(WifiDirectDeviceId localDeviceId, result r) = 0;
/**
* Called to notify the application when a Wi-Fi Direct connection is established with a remote device.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] localDeviceId An ID for a Wi-Fi Direct device
* @param[in] remoteDeviceInfo The remote device
* @exception E_OPERATION_CANCELED The operation has been cancelled explicitly.
* @exception E_AUTHENTICATION The authentication has failed during the Wi-Fi connection process.
* @exception E_NOT_RESPONDING The remote device is not responding.
- * @see WifiDirectDevice::Connect()
- * @see WifiDirectDevice::CancelConnect()
+ * @see WifiDirectDevice::Connect()
+ * @see WifiDirectDevice::CancelConnect()
*/
- virtual void OnWifiDirectConnected(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& remoteDeviceInfo, result r) = 0;
+ virtual void OnWifiDirectConnected(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& remoteDeviceInfo,
+ result r) = 0;
/**
* Called to notify the application when the Wi-Fi Direct connection is disconnected with a peer device.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] peerMacAddress The mac address of the peer device
- * @param[in] r An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] peerMacAddress The mac address of the peer device
+ * @param[in] r An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
* @see WifiDirectDevice::Disconnect()
*/
- virtual void OnWifiDirectDisconnected(WifiDirectDeviceId localDeviceId, const Tizen::Base::String& peerMacAddress, result r) = 0;
+ virtual void OnWifiDirectDisconnected(WifiDirectDeviceId localDeviceId, const Tizen::Base::String& peerMacAddress,
+ result r) = 0;
/**
* Called to notify the application when an autonomous group is created.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] r An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @see WifiDirectDevice::CreateAutonomousGroup()
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] r An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @see WifiDirectDevice::CreateAutonomousGroup()
*/
virtual void OnWifiDirectAutonomousGroupCreated(WifiDirectDeviceId localDeviceId, result r) = 0;
/**
* Called to notify the application when a local device leaves the group.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] r An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] r An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
* @see WifiDirectDevice::LeaveGroup()
*/
virtual void OnWifiDirectGroupLeft(WifiDirectDeviceId localDeviceId, result r) = 0;
/**
* @if OSPDEPREC
- * Called to notify the application about the result and related information when a group is created or when a request to create a group is cancelled.
- * cancellation.
+ * Called to notify the application about the result and related information when a group is created or when a
+ * request to create a group is cancelled.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs. @n
- * Instead of using this method, use OnWifiDirectConnected() or OnWifiDirectAutonomousGroupCreated() method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs. @n
+ * Instead of using this method, use OnWifiDirectConnected() or OnWifiDirectAutonomousGroupCreated()
+ * method.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] wifiDirectGroupInfo The WifiDirectGroupInfo instance set by the winning group owner after negotiation
+ * @param[in] wifiDirectGroupInfo The WifiDirectGroupInfo instance set by the winning group owner after
+ * negotiation
* @param[in] wifiDirectGroupOwnerDeviceInfo The WifiDirectDeviceInfo instance of the group owner
* @param[in] pWifiDirectMember The WifiDirectGroupMember instance that is casted to the instance of
* WifiDirectGroupOwner or WifiDirectGroupClient as a result of negotiation
* after the creation of a group
* @param[in] r An error code
- * @exception E_SUCCESS The Wi-Fi Direct group creation is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OPERATION_CANCELED The operation has been cancelled explicitly.
- * @exception E_AUTHENTICATION The authentication has failed during the Wi-Fi connection process.
- * @exception E_DHCP The DHCP operation has failed.
- * @exception E_NOT_RESPONDING The target is not responding.
- * @exception E_REJECTED The connection request has been rejected.
- * @exception E_REMOTE_DEVICE_NOT_FOUND The Wi-Fi Direct device has not been found.
- * @remarks If a device becomes a group client, then the WifiDirectGroupInfo::GetGroupOwnerIntent() and WifiDirectGroupInfo::GetMaxNumberOfClients() methods will not contain valid information.
+ * @exception E_SUCCESS The Wi-Fi Direct group creation is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OPERATION_CANCELED The operation has been cancelled explicitly.
+ * @exception E_AUTHENTICATION The authentication has failed during the Wi-Fi connection process.
+ * @exception E_DHCP The DHCP operation has failed.
+ * @exception E_NOT_RESPONDING The target is not responding.
+ * @exception E_REJECTED The connection request has been rejected.
+ * @exception E_REMOTE_DEVICE_NOT_FOUND The Wi-Fi Direct device has not been found.
+ * @remarks If a device becomes a group client, then the WifiDirectGroupInfo::GetGroupOwnerIntent() and
+ * WifiDirectGroupInfo::GetMaxNumberOfClients() methods will not contain valid information.
* @see WifiDirectDevice::CreateGroup()
* @see WifiDirectDevice::CancelGroupCreation()
* @endif
*/
- virtual void OnWifiDirectGroupCreatedN(WifiDirectDeviceId localDeviceId, const WifiDirectGroupInfo& wifiDirectGroupInfo, const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo, WifiDirectGroupMember* pWifiDirectMember, result r) { delete pWifiDirectMember; }
+ virtual void OnWifiDirectGroupCreatedN(WifiDirectDeviceId localDeviceId, const WifiDirectGroupInfo& wifiDirectGroupInfo,
+ const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo, WifiDirectGroupMember* pWifiDirectMember, result r)
+ { delete pWifiDirectMember; }
/**
* Called to notify the application when the scan is completed.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] pWifiDirectDeviceInfoList The WifiDirectDeviceInfo information list representing the
- * Wi-Fi Direct devices discovered by scan
- * @param[in] r An error code
- * @exception E_SUCCESS The scan is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OPERATION_CANCELED The operation has been cancelled explicitly.
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] pWifiDirectDeviceInfoList The WifiDirectDeviceInfo information list representing the
+ * Wi-Fi Direct devices discovered by scan
+ * @param[in] r An error code
+ * @exception E_SUCCESS The scan is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OPERATION_CANCELED The operation has been cancelled explicitly.
* @see WifiDirectDevice::Scan()
* @see WifiDirectDevice::CancelScan()
*/
- virtual void OnWifiDirectScanCompletedN(WifiDirectDeviceId localDeviceId, Tizen::Base::Collection::IList* pWifiDirectDeviceInfoList, result r) = 0;
+ virtual void OnWifiDirectScanCompletedN(WifiDirectDeviceId localDeviceId,
+ Tizen::Base::Collection::IList* pWifiDirectDeviceInfoList, result r) = 0;
/**
* @if OSPDEPREC
* Called to notify the application when the connection to a Wi-Fi Direct group owner is completely established.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs. @n
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs. @n
* Instead of using this method, use OnWifiDirectConnected() method.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] wifiDirectGroupOwnerDeviceInfo The WifiDirectDeviceInfo of the connected Wi-Fi Direct group
- * owner
- * @param[in] r An error code
- * @exception E_SUCCESS The association is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_AUTHENTICATION The authentication has failed during the Wi-Fi connection process.
- * @exception E_DHCP The DHCP operation has failed.
- * @exception E_NOT_RESPONDING The target is not responding.
- * @exception E_REJECTED The connection request has been rejected.
- * @exception E_REMOTE_DEVICE_NOT_FOUND The Wi-Fi Direct device has not been found.
- * @see WifiDirectDevice::Associate()
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] wifiDirectGroupOwnerDeviceInfo The WifiDirectDeviceInfo of the connected Wi-Fi Direct group
+ * owner
+ * @param[in] r An error code
+ * @exception E_SUCCESS The association is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_AUTHENTICATION The authentication has failed during the Wi-Fi connection process.
+ * @exception E_DHCP The DHCP operation has failed.
+ * @exception E_NOT_RESPONDING The target is not responding.
+ * @exception E_REJECTED The connection request has been rejected.
+ * @exception E_REMOTE_DEVICE_NOT_FOUND The Wi-Fi Direct device has not been found.
+ * @see WifiDirectDevice::Associate()
* @endif
*/
- virtual void OnWifiDirectAssociationCompleted(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo, result r) {}
+ virtual void OnWifiDirectAssociationCompleted(WifiDirectDeviceId localDeviceId,
+ const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo, result r) {}
/**
- * Called to notify the application when a remote device is found during the Wi-Fi Direct scan process.
- *
- * @since 2.1
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] remoteDeviceInfo The remote device that is found
- * @see WifiDirectDevice::Scan()
- */
- virtual void OnWifiDirectRemoteDeviceFound(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& remoteDeviceInfo) {}
+ * Called to notify the application when a remote device is found during the Wi-Fi Direct scan process.
+ *
+ * @since 2.1
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] remoteDeviceInfo The remote device that is found
+ * @see WifiDirectDevice::Scan()
+ */
+ virtual void OnWifiDirectRemoteDeviceFound(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& remoteDeviceInfo) {}
protected:
//
//
// This method is reserved and may change its name at any time without prior notice.
//
- // @since 2.0
+ // @since 2.0
//
virtual void OnWifiDirectDeviceListener_Reserved1(void) {}
//
// This method is reserved and may change its name at any time without prior notice.
//
- // @since 2.0
+ // @since 2.0
//
virtual void OnWifiDirectDeviceListener_Reserved2(void) {}
//
// This method is reserved and may change its name at any time without prior notice.
//
- // @since 2.0
+ // @since 2.0
//
virtual void OnWifiDirectDeviceListener_Reserved3(void) {}
//
// This method is reserved and may change its name at any time without prior notice.
//
- // @since 2.0
+ // @since 2.0
//
virtual void OnWifiDirectDeviceListener_Reserved4(void) {}
// limitations under the License.
//
/**
- * @file FNetWifiIWifiDirectGroupClientListener.h
- * @brief This is the header file for the %IWifiDirectGroupClientListener interface.
+ * @file FNetWifiIWifiDirectGroupClientListener.h
+ * @brief This is the header file for the %IWifiDirectGroupClientListener interface.
*
* This header file contains the declarations of the %IWifiDirectGroupClientListener interface.
*/
* @interface IWifiDirectGroupClientListener
* @brief <i> [Deprecated] </i> This interface implements listeners for the WifiDirectGroupClient events.
* @deprecated The WifiDirectGroupClient class is deprecated, therefore, this interface is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * The Wi-Fi Direct APIs have now been revised to allow the use of APIs with ease irrespective of the role. Now the APIs have been integrated into the IWifiDirectDeviceListener interface. @n
- *
- * Instead of using the %IWifiDirectGroupClientListener interface, use the %IWifiDirectDeviceListener interface.
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner,
+ * group client, and so on) and so it was necessary to use these APIs. @n
+ * The Wi-Fi Direct APIs have now been revised to allow the use of APIs with ease irrespective of the
+ * role. Now the APIs have been integrated into the IWifiDirectDeviceListener interface. @n
+ * Instead of using the %IWifiDirectGroupClientListener interface, use the %IWifiDirectDeviceListener
+ * interface.
*
* @since 2.0
*
- * The %IWifiDirectGroupClientListener interface represents a listener that is used to obtain the Wi-Fi Direct client status or information.
+ * The %IWifiDirectGroupClientListener interface represents a listener that is used to obtain the Wi-Fi Direct client
+ * status or information.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
* @endif
*/
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
- /**
- * @if OSPDEPREC
- * This polymorphic destructor should be overridden if required. This way,
- * the destructors of the derived classes are called when the destructor of this interface is called.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this destructor is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * However, now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
- *
- *
- * @since 2.0
- * @endif
- */
- virtual ~IWifiDirectGroupClientListener(void) {}
+ /**
+ * @if OSPDEPREC
+ * This polymorphic destructor should be overridden if required. This way,
+ * the destructors of the derived classes are called when the destructor of this interface is called.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this destructor is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * However, now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease
+ * irrespective of the role.
+ *
+ * @since 2.0
+ * @endif
+ */
+ virtual ~IWifiDirectGroupClientListener(void) {}
- /**
- * @if OSPDEPREC
- * Called to notify the application when the connection to a Wi-Fi Direct group owner is terminated.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
- * As these APIs have now been integrated into the IWifiDirectDeviceListener interface, use IWifiDirectDeviceListener::OnWifiDirectDisconnected() method instead.
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] reason The reason to terminate this association
- * @param[in] r An error code
- * @exception E_SUCCESS The disassociation is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_NOT_RESPONDING The target is not responding.
- * @remarks When a device is disconnected by itself using WifiDirectGroupClient::Disassociate() method, this event is invoked with Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_SELF_INITIATED. @n
- * When a device is disconnected by a group owner using WifiDirectGroupOwner::Disconnect() method, due to no range, or due to abrupt connection loss to the group owner, this event is invoked with Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_DISCONNECTED.
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application when the connection to a Wi-Fi Direct group owner is terminated.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * As these APIs have now been integrated into the IWifiDirectDeviceListener interface, use
+ * IWifiDirectDeviceListener::OnWifiDirectDisconnected() method instead.
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] reason The reason to terminate this association
+ * @param[in] r An error code
+ * @exception E_SUCCESS The disassociation is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_NOT_RESPONDING The target is not responding.
+ * @remarks When a device is disconnected by itself using WifiDirectGroupClient::Disassociate() method, this
+ * event is invoked with Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_SELF_INITIATED. @n
+ * When a device is disconnected by a group owner using WifiDirectGroupOwner::Disconnect() method, due
+ * to no range, or due to abrupt connection loss to the group owner, this event is invoked with
+ * Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_DISCONNECTED.
* @see WifiDirectGroupClient::Disassociate()
- * @endif
- */
- virtual void OnWifiDirectAssociationTerminated(WifiDirectDeviceId localDeviceId, WifiDirectAssociationTerminationReason reason, result r) = 0;
+ * @endif
+ */
+ virtual void OnWifiDirectAssociationTerminated(WifiDirectDeviceId localDeviceId,
+ WifiDirectAssociationTerminationReason reason, result r) = 0;
- /**
- * @if OSPDEPREC
- * Called to notify the application when the request to acquire the WifiDirectDeviceInfo from a Wi-Fi Direct group owner is received.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
- * So the APIs have been integrated into the WifiDirectDevice class. Hence, use the WifiDirectDevice::GetGroupOwnerInfoN() method instead.
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] wifiDirectGroupOwnerDeviceInfo The WifiDirectDeviceInfo instance of the Wi-Fi Direct group owner
- * @param[in] r An error code
- * @exception E_SUCCESS The request for acquiring group owner information is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_ALREADY_BOUND The specified port number is already in use.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_NOT_RESPONDING The target is not responding.
- * @see WifiDirectGroupClient::RequestGroupOwnerInfo()
- * @endif
- */
- virtual void OnWifiDirectGroupOwnerInfoReceived(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo, result r) = 0;
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application when the request to acquire the WifiDirectDeviceInfo from a Wi-Fi Direct group
+ * owner is received.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * So the APIs have been integrated into the WifiDirectDevice class. Hence, use the
+ * WifiDirectDevice::GetGroupOwnerInfoN() method instead.
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] wifiDirectGroupOwnerDeviceInfo The WifiDirectDeviceInfo instance of the Wi-Fi Direct group owner
+ * @param[in] r An error code
+ * @exception E_SUCCESS The request for acquiring group owner information is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_ALREADY_BOUND The specified port number is already in use.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_NOT_RESPONDING The target is not responding.
+ * @see WifiDirectGroupClient::RequestGroupOwnerInfo()
+ * @endif
+ */
+ virtual void OnWifiDirectGroupOwnerInfoReceived(WifiDirectDeviceId localDeviceId,
+ const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo, result r) = 0;
- /**
- * @if OSPDEPREC
- * Called to notify the application that the WifiDirectDeviceInfo list of group members has been received.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * This is because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] pWifiDirectDeviceInfoList The list of WifiDirectDeviceInfo, @n
- * else @c null if it fails
- * @param[in] r An error code
- * @exception E_SUCCESS The response has been received successfully.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_ALREADY_BOUND The specified port number is already in use.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_NOT_RESPONDING The group owner is not reachable.
- * @see WifiDirectGroupClient::RequestAllGroupMemberInfo()
- * @endif
- */
- virtual void OnWifiDirectAllGroupMemberInfoReceivedN(WifiDirectDeviceId localDeviceId, Tizen::Base::Collection::IList* pWifiDirectDeviceInfoList, result r) = 0;
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application that the WifiDirectDeviceInfo list of group members has been received.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * This is because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease
+ * irrespective of the role. @n
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] pWifiDirectDeviceInfoList The list of WifiDirectDeviceInfo, @n
+ * else @c null if it fails
+ * @param[in] r An error code
+ * @exception E_SUCCESS The response has been received successfully.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_ALREADY_BOUND The specified port number is already in use.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_NOT_RESPONDING The group owner is not reachable.
+ * @see WifiDirectGroupClient::RequestAllGroupMemberInfo()
+ * @endif
+ */
+ virtual void OnWifiDirectAllGroupMemberInfoReceivedN(WifiDirectDeviceId localDeviceId,
+ Tizen::Base::Collection::IList* pWifiDirectDeviceInfoList, result r) = 0;
protected:
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupClientListener_Reserved1(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupClientListener_Reserved1(void) {}
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupClientListener_Reserved2(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupClientListener_Reserved2(void) {}
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupClientListener_Reserved3(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupClientListener_Reserved3(void) {}
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupClientListener_Reserved4(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupClientListener_Reserved4(void) {}
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupClientListener_Reserved5(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupClientListener_Reserved5(void) {}
}; // IWifiDirectGroupClientListener
} } } //Tizen::Net::Wifi
// limitations under the License.
//
/**
- * @file FNetWifiIWifiDirectGroupOwnerListener.h
- * @brief This is the header file for the %IWifiDirectGroupOwnerListener interface.
+ * @file FNetWifiIWifiDirectGroupOwnerListener.h
+ * @brief This is the header file for the %IWifiDirectGroupOwnerListener interface.
*
* This header file contains the declarations of the %IWifiDirectGroupOwnerListener interface.
*/
* @interface IWifiDirectGroupOwnerListener
* @brief <i> [Deprecated] </i> This interface implements listeners for the WifiDirectGroupOwner events.
* @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this interface is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner, group client, and so on) and so it was necessary to use these APIs. Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- * As the APIs have been integrated into the IWifiDirectDeviceListener interface. Hence, use the IWifiDirectDeviceListener interface instead.
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role(for example, group owner,
+ * group client, and so on) and so it was necessary to use these APIs. Now the Wi-Fi Direct APIs have been
+ * revised to allow the use of APIs with ease irrespective of the role. @n
+ * As the APIs have been integrated into the IWifiDirectDeviceListener interface. Hence, use the
+ * IWifiDirectDeviceListener interface instead.
*
* @since 2.0
*
- * The %IWifiDirectGroupOwnerListener interface represents a listener that is used to obtain the Wi-Fi Direct group owner's status or information.
+ * The %IWifiDirectGroupOwnerListener interface represents a listener that is used to obtain the Wi-Fi Direct group
+ * owner's status or information.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
* @endif
*/
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
- /**
- * @if OSPDEPREC
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this destructor is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role for example, group owner, group client, and so on) and so it was necessary to use these APIs. Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
- *
- *
- * @since 2.0
- * @endif
- */
- virtual ~IWifiDirectGroupOwnerListener(void) {}
-
- /**
- * @if OSPDEPREC
- * Called to notify the application that a successful association has occurred with a client.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
- * As the APIs have been integrated into the IWifiDirectDeviceListener interface, use the IWifiDirectDeviceListener::OnWifiDirectConnected() method instead.
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] wifiDirectClientInfo The WifiDirectDeviceInfo instance of an associated node
- * @endif
- */
- virtual void OnWifiDirectClientAssociated(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& wifiDirectClientInfo) = 0;
-
- /**
- * @if OSPDEPREC
- * Called to notify the application that a disassociation has occurred with a client.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
- * As the APIs have been integrated into the IWifiDirectDeviceListener interface, use the IWifiDirectDeviceListener::OnWifiDirectDisconnected() method instead.
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] wifiDirectClientInfo The WifiDirectDeviceInfo instance of a disassociated node
- * @param[in] reason The reason of termination of an association
- * @remarks When a client is disconnected by a group owner using WifiDirectGroupOwner::Disconnect, this event is invoked with Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_SELF_INITIATED. @n
- * When a client is disconnected by itself using WifiDirectGroupClient::Disassociate(), due to no range, or due to abrupt connection loss to the group owner, this event is invoked with Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_DISCONNECTED.
- * @endif
- */
- virtual void OnWifiDirectClientDisassociated(WifiDirectDeviceId localDeviceId, const WifiDirectDeviceInfo& wifiDirectClientInfo, WifiDirectAssociationTerminationReason reason) = 0;
-
- /**
- * @if OSPDEPREC
- * Called to notify the application when the Wi-Fi Direct group is destroyed.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
-
- * As the APIs have been integrated into the IWifiDirectDeviceListener interface, use the IWifiDirectDeviceListener::OnWifiDirectDisconnected() or IWifiDirectDeviceListener::OnWifiDirectGroupLeft() method instead.
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] r An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @see WifiDirectGroupOwner::DestroyGroup()
- * @endif
- */
- virtual void OnWifiDirectGroupDestroyed(WifiDirectDeviceId localDeviceId, result r) = 0;
-
- /**
- * @if OSPDEPREC
- * Called to notify the application that the group member information service has started.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
-
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] pNetConnection The network connection that started with the Wi-Fi Direct net account, @n
- * else @c null if the system fails to start the network connection @n
- * @param[in] r An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_ALREADY_BOUND The specified port number is already in use.
- * @see WifiDirectGroupOwner::StartGroupMemberInfoService()
- * @endif
- */
- virtual void OnWifiDirectGroupMemberInfoServiceStarted(WifiDirectDeviceId localDeviceId, const Tizen::Net::NetConnection* pNetConnection, result r) = 0;
-
- /**
- * @if OSPDEPREC
- * Called to notify the application that the group member information service has stopped.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
-
- *
- * @since 2.0
- *
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- * @param[in] r An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @see WifiDirectGroupOwner::StopGroupMemberInfoService()
- * @endif
- */
- virtual void OnWifiDirectGroupMemberInfoServiceStopped(WifiDirectDeviceId localDeviceId, result r) = 0;
+ /**
+ * @if OSPDEPREC
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this destructor is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. Now the Wi-Fi Direct
+ * APIs have been revised to allow the use of APIs with ease irrespective of the role.
+ *
+ * @since 2.0
+ * @endif
+ */
+ virtual ~IWifiDirectGroupOwnerListener(void) {}
+
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application that a successful association has occurred with a client.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * As the APIs have been integrated into the IWifiDirectDeviceListener interface, use the
+ * IWifiDirectDeviceListener::OnWifiDirectConnected() method instead.
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] wifiDirectClientInfo The WifiDirectDeviceInfo instance of an associated node
+ * @endif
+ */
+ virtual void OnWifiDirectClientAssociated(WifiDirectDeviceId localDeviceId,
+ const WifiDirectDeviceInfo& wifiDirectClientInfo) = 0;
+
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application that a disassociation has occurred with a client.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * As the APIs have been integrated into the IWifiDirectDeviceListener interface, use the
+ * IWifiDirectDeviceListener::OnWifiDirectDisconnected() method instead.
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] wifiDirectClientInfo The WifiDirectDeviceInfo instance of a disassociated node
+ * @param[in] reason The reason of termination of an association
+ * @remarks - When a client is disconnected by a group owner using WifiDirectGroupOwner::Disconnect, this event
+ * is invoked with Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_SELF_INITIATED. @n
+ * - When a client is disconnected by itself using WifiDirectGroupClient::Disassociate(), due to no
+ * range, or due to abrupt connection loss to the group owner, this event is invoked with
+ * Wifi::WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_DISCONNECTED.
+ * @endif
+ */
+ virtual void OnWifiDirectClientDisassociated(WifiDirectDeviceId localDeviceId,
+ const WifiDirectDeviceInfo& wifiDirectClientInfo, WifiDirectAssociationTerminationReason reason) = 0;
+
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application when the Wi-Fi Direct group is destroyed.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * As the APIs have been integrated into the IWifiDirectDeviceListener interface, use the
+ * IWifiDirectDeviceListener::OnWifiDirectDisconnected() or
+ * IWifiDirectDeviceListener::OnWifiDirectGroupLeft() method instead.
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] r An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @see WifiDirectGroupOwner::DestroyGroup()
+ * @endif
+ */
+ virtual void OnWifiDirectGroupDestroyed(WifiDirectDeviceId localDeviceId, result r) = 0;
+
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application that the group member information service has started.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role.
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] pNetConnection The network connection that started with the Wi-Fi Direct net account, @n
+ * else @c null if the system fails to start the network connection @n
+ * @param[in] r An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_ALREADY_BOUND The specified port number is already in use.
+ * @see WifiDirectGroupOwner::StartGroupMemberInfoService()
+ * @endif
+ */
+ virtual void OnWifiDirectGroupMemberInfoServiceStarted(WifiDirectDeviceId localDeviceId,
+ const Tizen::Net::NetConnection* pNetConnection, result r) = 0;
+
+ /**
+ * @if OSPDEPREC
+ * Called to notify the application that the group member information service has stopped.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role.
+ *
+ * @since 2.0
+ *
+ * @param[in] localDeviceId An ID for a Wi-Fi Direct device
+ * @param[in] r An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @see WifiDirectGroupOwner::StopGroupMemberInfoService()
+ * @endif
+ */
+ virtual void OnWifiDirectGroupMemberInfoServiceStopped(WifiDirectDeviceId localDeviceId, result r) = 0;
protected:
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupOwnerListener_Reserved1(void) {}
-
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupOwnerListener_Reserved2(void) {}
-
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupOwnerListener_Reserved3(void) {}
-
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupOwnerListener_Reserved4(void) {}
-
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void OnWifiDirectGroupOwnerListener_Reserved5(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupOwnerListener_Reserved1(void) {}
+
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupOwnerListener_Reserved2(void) {}
+
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupOwnerListener_Reserved3(void) {}
+
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupOwnerListener_Reserved4(void) {}
+
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void OnWifiDirectGroupOwnerListener_Reserved5(void) {}
}; // IWifiDirectGroupOwnerListener
} } } //Tizen::Net::Wifi
// limitations under the License.
//
/**
- * @file FNetWifiIWifiManagerEventListener.h
- * @brief This is the header file for the %IWifiManagerEventListener interface.
+ * @file FNetWifiIWifiManagerEventListener.h
+ * @brief This is the header file for the %IWifiManagerEventListener interface.
*
* This header file contains the declarations of the %IWifiManagerEventListener interface.
*
* @interface IWifiManagerEventListener
* @brief This interface provides the listeners for WifiManager events.
*
- * @since 2.0
+ * @since 2.0
*
- * The %IWifiManagerEventListener interface specifies the methods used for creating notifications about the different kinds of WifiManager events. These events are only sent
- * out when using %WifiManager. When a %WifiManager event is generated, a method of this class is called. Thus, if an application provides any functionality related to the %WifiManager events, override and use the methods of this interface.
- * This interface specifies the methods used for creating notifications about the different kinds of %WifiManager events.
- *
+ * The %IWifiManagerEventListener interface specifies the methods used for creating notifications about the different
+ * kinds of WifiManager events. These events are only sent out when using %WifiManager. When a %WifiManager event is
+ * generated, a method of this class is called. Thus, if an application provides any functionality related to the
+ * %WifiManager events, override and use the methods of this interface. This interface specifies the methods used for
+ * creating notifications about the different kinds of %WifiManager events.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
*/
class _OSP_EXPORT_ IWifiManagerEventListener
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way,
- * the destructors of the derived classes are called when the destructor of this interface is called.
- *
- * @since 2.0
- */
- virtual ~IWifiManagerEventListener(void) {}
+ /**
+ * This polymorphic destructor should be overridden if required. This way,
+ * the destructors of the derived classes are called when the destructor of this interface is called.
+ *
+ * @since 2.0
+ */
+ virtual ~IWifiManagerEventListener(void) {}
- /**
- * Called to notify the application that the local Wi-Fi radio is activated.
- *
- * @since 2.0
- *
- * @param[in] r The error code that occurs during the activation
- * @exception E_SUCCESS The activation is successful.
- * @exception E_FAILURE The method has failed to activate.
- * @see WifiManager::Activate()
- */
- virtual void OnWifiActivated(result r) = 0;
+ /**
+ * Called to notify the application that the local Wi-Fi radio is activated.
+ *
+ * @since 2.0
+ *
+ * @param[in] r The error code that occurs during the activation
+ * @exception E_SUCCESS The activation is successful.
+ * @exception E_FAILURE The method has failed to activate.
+ * @see WifiManager::Activate()
+ */
+ virtual void OnWifiActivated(result r) = 0;
- /**
- * Called to notify the application that the local Wi-Fi radio is deactivated.
- *
- * @since 2.0
- *
- * @param[in] r The error code that occurs during the deactivation
- * @exception E_SUCCESS The deactivation is successful.
- * @exception E_FAILURE The method has failed to deactivate.
- * @see WifiManager::Deactivate()
- */
- virtual void OnWifiDeactivated(result r) = 0;
+ /**
+ * Called to notify the application that the local Wi-Fi radio is deactivated.
+ *
+ * @since 2.0
+ *
+ * @param[in] r The error code that occurs during the deactivation
+ * @exception E_SUCCESS The deactivation is successful.
+ * @exception E_FAILURE The method has failed to deactivate.
+ * @see WifiManager::Deactivate()
+ */
+ virtual void OnWifiDeactivated(result r) = 0;
- /**
- * Called to notify that the connection to an access point (only an infrastructure mode BSS) has been completely established.
- *
- * @since 2.0
- *
- * @param[in] ssid The SSID of the connected BSS
- * @param[in] r The error code that occurs during the connection
- * @exception E_SUCCESS The connection is successful.
- * @exception E_FAILURE The method has failed to connect.
- * @exception E_AUTHENTICATION The authentication fails when Wi-Fi is connected.
- * @exception E_NOT_RESPONDING The target is not responding when Wi-Fi is connected.
- * @exception E_DHCP The DHCP fails in case of a dynamic IP.
- * @see WifiManager::Connect()
- */
- virtual void OnWifiConnected(const Tizen::Base::String& ssid, result r) = 0;
+ /**
+ * Called to notify that the connection to an access point (only an infrastructure mode BSS) has been completely
+ * established.
+ *
+ * @since 2.0
+ *
+ * @param[in] ssid The SSID of the connected BSS
+ * @param[in] r The error code that occurs during the connection
+ * @exception E_SUCCESS The connection is successful.
+ * @exception E_FAILURE The method has failed to connect.
+ * @exception E_AUTHENTICATION The authentication fails when Wi-Fi is connected.
+ * @exception E_NOT_RESPONDING The target is not responding when Wi-Fi is connected.
+ * @exception E_DHCP The DHCP fails in case of a dynamic IP.
+ * @see WifiManager::Connect()
+ */
+ virtual void OnWifiConnected(const Tizen::Base::String& ssid, result r) = 0;
- /**
- * Called to notify that the connection to a BSS has been terminated.
- *
- * @since 2.0
- */
- virtual void OnWifiDisconnected(void) = 0;
+ /**
+ * Called to notify that the connection to a BSS has been terminated.
+ *
+ * @since 2.0
+ */
+ virtual void OnWifiDisconnected(void) = 0;
- /**
- * Called to notify that the Received Signal Strength Indication (RSSI) from BSS has been changed.
- *
- * @since 2.0
- *
- * @param[in] rssi The updated RSSI value (dbm)
- */
- virtual void OnWifiRssiChanged(long rssi) = 0;
+ /**
+ * Called to notify that the Received Signal Strength Indication (RSSI) from BSS has been changed.
+ *
+ * @since 2.0
+ *
+ * @param[in] rssi The updated RSSI value (dbm)
+ */
+ virtual void OnWifiRssiChanged(long rssi) = 0;
- /**
- * Called to notify that the scan to find the access points has been completed.
- *
- * @since 2.0
- *
- * @param[in] pWifiBssInfoList The list of WifiBssInfo information representing the access points discovered by the scan
- * @param[in] r The error code that occurs during the scan
- * @exception E_SUCCESS The scan is successful.
- * @exception E_FAILURE The scan has failed.
- * @see WifiManager::Scan()
- */
- virtual void OnWifiScanCompletedN(const Tizen::Base::Collection::IList* pWifiBssInfoList, result r) = 0;
+ /**
+ * Called to notify that the scan to find the access points has been completed.
+ *
+ * @since 2.0
+ *
+ * @param[in] pWifiBssInfoList The list of WifiBssInfo information representing the access points discovered
+ * by the scan
+ * @param[in] r The error code that occurs during the scan
+ * @exception E_SUCCESS The scan is successful.
+ * @exception E_FAILURE The scan has failed.
+ * @see WifiManager::Scan()
+ */
+ virtual void OnWifiScanCompletedN(const Tizen::Base::Collection::IList* pWifiBssInfoList, result r) = 0;
protected:
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void IWifiManagerEventListener_Reserved1(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void IWifiManagerEventListener_Reserved1(void) {}
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void IWifiManagerEventListener_Reserved2(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void IWifiManagerEventListener_Reserved2(void) {}
}; // IWifiManagerEventListener
} } } // Tizen::Net::Wifi
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
- /**
- * This polymorphic destructor should be overridden if required.
- * This way, the destructors of the derived classes are called when the destructor of this interface is called.
- *
- * @since 2.0
- */
- virtual ~IWifiSystemMonitoringEventListener(void) {}
+ /**
+ * This polymorphic destructor should be overridden if required.
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ *
+ * @since 2.0
+ */
+ virtual ~IWifiSystemMonitoringEventListener(void) {}
- /**
- * Called to notify the application that the state of local Wi-Fi connection is changed.
- *
- * @since 2.0
+ /**
+ * Called to notify the application that the state of local Wi-Fi connection is changed.
+ *
+ * @since 2.0
*
- * @param[in] state The state of the Wi-Fi current connection
- * @remarks When the local device is connected with a particular access point,
- * IWifiManagerEventListener::OnWifiConnected() as well as this method with @c WIFI_CONN_STATE_CONNECTED
- * are called. Therefore, be careful to manipulate only one of those methods. So are the cases of
- * IWifiManagerEventListener::OnWifiDisconnected() and this method with @c WIFI_CONN_STATE_NOT_CONNECTED.
- */
- virtual void OnWifiConnectionStateChanged(WifiConnectionState state) = 0;
+ * @param[in] state The state of the Wi-Fi current connection
+ * @remarks When the local device is connected with a particular access point,
+ * IWifiManagerEventListener::OnWifiConnected() as well as this method with
+ * @c WIFI_CONN_STATE_CONNECTED are called. Therefore, be careful to manipulate only one of those
+ * methods. So are the cases of IWifiManagerEventListener::OnWifiDisconnected() and this method with
+ * @c WIFI_CONN_STATE_NOT_CONNECTED.
+ */
+ virtual void OnWifiConnectionStateChanged(WifiConnectionState state) = 0;
- /**
- * Called to notify the application that the scan result of Wi-Fi system on background is updated.
- *
- * @since 2.0
+ /**
+ * Called to notify the application that the scan result of Wi-Fi system on background is updated.
+ *
+ * @since 2.0
*
- * @remarks Call WifiManager::GetSystemScanResultN() for checking the content of this update.
- */
- virtual void OnWifiSystemScanResultUpdated(void) = 0;
+ * @remarks Call WifiManager::GetSystemScanResultN() for checking the content of this update.
+ */
+ virtual void OnWifiSystemScanResultUpdated(void) = 0;
protected:
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related
- // issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void IWifiSystemMonitoringEventListener_Reserved1(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related
+ // issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void IWifiSystemMonitoringEventListener_Reserved1(void) {}
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related
- // issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void IWifiSystemMonitoringEventListener_Reserved2(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related
+ // issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void IWifiSystemMonitoringEventListener_Reserved2(void) {}
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related
- // issues in the application.
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void IWifiSystemMonitoringEventListener_Reserved3(void) {}
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related
+ // issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void IWifiSystemMonitoringEventListener_Reserved3(void) {}
}; // IWifiSystemMonitoringEventListener
*/
virtual ~WifiBssInfo(void);
- /**
- * Gets the SSID of this BSS.
- *
- * @since 2.0
- *
- * @return The SSID
- */
- Tizen::Base::String GetSsid(void) const;
-
- /**
- * Gets the ID of this BSS.
- *
- * @since 2.0
- *
- * @return The BSSID expressed as a 6 byte hexadecimal value delimited by dashes @n
- * For example, "00-3D-47-EF-8A-03".
- */
- Tizen::Base::String GetBssId(void) const;
-
- /**
- * Gets the type of this BSS.
- *
- * @since 2.0
- *
- * @return The type of this BSS
- */
- WifiBssType GetBssType(void) const;
-
- /**
- * Gets the radio channel of this BSS.
- *
- * @since 2.0
- *
- * @return The radio channel of this BSS
- */
- WifiRadioChannel GetRadioChannel(void) const;
-
- /**
- * Gets the security information of this BSS.
- *
- * @since 2.0
- *
- * @return The authentication and encryption type of this BSS
- */
- const WifiSecurityInfo* GetSecurityInfo(void) const;
-
- /**
- * Gets the Received Signal Strength Indication (RSSI) value of the BSS at the time of scanning.
- *
- * @since 2.0
- *
- * @return The RSSI value in dBm
- */
- long GetRssi(void) const;
-
- /**
- * Gets the data rate of this BSS.
- *
- * @since 2.0
- *
- * @return The data rate value (Mbps), @n
- * else @c -1.0 if the supported data rate is unknown
- */
- float GetDataRate(void) const;
-
- /**
- * Sets the SSID.
- *
- * @since 2.0
- *
- * @param[in] ssid The SSID
- */
- void SetSsid(const Tizen::Base::String& ssid);
-
- /**
- * Checks whether an access point (BSS) is known or not. @n
+ /**
+ * Gets the SSID of this BSS.
+ *
+ * @since 2.0
+ *
+ * @return The SSID
+ */
+ Tizen::Base::String GetSsid(void) const;
+
+ /**
+ * Gets the ID of this BSS.
+ *
+ * @since 2.0
+ *
+ * @return The BSSID expressed as a 6 byte hexadecimal value delimited by dashes. @n
+ * For example, "00-3D-47-EF-8A-03".
+ */
+ Tizen::Base::String GetBssId(void) const;
+
+ /**
+ * Gets the type of this BSS.
+ *
+ * @since 2.0
+ *
+ * @return The type of this BSS
+ */
+ WifiBssType GetBssType(void) const;
+
+ /**
+ * Gets the radio channel of this BSS.
+ *
+ * @since 2.0
+ *
+ * @return The radio channel of this BSS
+ */
+ WifiRadioChannel GetRadioChannel(void) const;
+
+ /**
+ * Gets the security information of this BSS.
+ *
+ * @since 2.0
+ *
+ * @return The authentication and encryption type of this BSS
+ */
+ const WifiSecurityInfo* GetSecurityInfo(void) const;
+
+ /**
+ * Gets the Received Signal Strength Indication (RSSI) value of the BSS at the time of scanning.
+ *
+ * @since 2.0
+ *
+ * @return The RSSI value in dBm
+ */
+ long GetRssi(void) const;
+
+ /**
+ * Gets the data rate of this BSS.
+ *
+ * @since 2.0
+ *
+ * @return The data rate value (Mbps), @n
+ * else @c -1.0 if the supported data rate is unknown
+ */
+ float GetDataRate(void) const;
+
+ /**
+ * Sets the SSID.
+ *
+ * @since 2.0
+ *
+ * @param[in] ssid The SSID
+ */
+ void SetSsid(const Tizen::Base::String& ssid);
+
+ /**
+ * Checks whether an access point (BSS) is known or not. @n
* The access point becomes a known BSS if it has been connected with this device.
- *
- * @since 2.0
- *
- * @return @c true if the access point is known, @n
- * else @c false
- * @see SetUnknown()
- */
- bool IsKnown(void) const;
-
- /**
- * Sets the access point (BSS) unknown.
- *
- * @since 2.0
- *
- * @see IsKnown()
- */
- void SetUnknown(void);
-
- /**
- * Gets the local IP address scheme.
- *
- * @since 2.0
- *
- * @return The address scheme for the local IP address
- */
- Tizen::Net::NetAddressScheme GetLocalAddressScheme(void) const;
-
- /**
- * Sets the local IP address scheme. @n
+ *
+ * @since 2.0
+ *
+ * @return @c true if the access point is known, @n
+ * else @c false
+ * @see SetUnknown()
+ */
+ bool IsKnown(void) const;
+
+ /**
+ * Sets the access point (BSS) unknown.
+ *
+ * @since 2.0
+ *
+ * @see IsKnown()
+ */
+ void SetUnknown(void);
+
+ /**
+ * Gets the local IP address scheme.
+ *
+ * @since 2.0
+ *
+ * @return The address scheme for the local IP address
+ */
+ Tizen::Net::NetAddressScheme GetLocalAddressScheme(void) const;
+
+ /**
+ * Sets the local IP address scheme. @n
* The %SetLocalAddressScheme() method allows determining whether to use static address or dynamic address.
- *
- * @since 2.0
- *
- * @param[in] scheme The address scheme for the local IP address
- */
- void SetLocalAddressScheme(Tizen::Net::NetAddressScheme scheme);
-
- /**
- * Gets the local IP address in the static address scheme.
- *
- * @since 2.0
- *
- * @return The local address configured to this access point, @n
- * else @c null if an error occurs or there is no previously set address
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see SetLocalAddress()
- */
- const Tizen::Net::IpAddress* GetLocalAddress(void) const;
-
- /**
- * Sets the local IP address in the static address scheme.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] pAddress The new address to assign
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation.
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The existing local address is unset when the input argument is @c null.
- * @see GetLocalAddress()
- */
- result SetLocalAddress(const Tizen::Net::IpAddress* pAddress);
-
- /**
- * Gets the subnet mask address in the static address scheme.
- *
- * @since 2.0
- *
- * @return The subnet mask address configured to this access point, @n
- * else @c null if an error occurs or there is no previously set address
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see SetSubnetMaskAddress()
- */
- const Tizen::Net::IpAddress* GetSubnetMaskAddress(void) const;
-
- /**
- * Sets the subnet mask address in the static address scheme.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] pAddress The new address to assign
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The existing subnet mask address is unset when the input argument is @c null.
- * @see GetSubnetMaskAddress()
- */
- result SetSubnetMaskAddress(const Tizen::Net::IpAddress* pAddress);
-
- /**
- * Gets the default gateway address in the static address scheme.
- *
- * @since 2.0
- *
- * @return The default gateway address configured to this access point, @n
- * else @c null if an error occurs or there is no previously set address
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see SetDefaultGatewayAddress()
- */
- const Tizen::Net::IpAddress* GetDefaultGatewayAddress(void) const;
-
- /**
- * Sets the default gateway address in the static address scheme.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] pAddress The new address to assign
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The existing gateway address is unset when the input argument is @c null.
- * @see GetDefaultGatewayAddress()
- */
- result SetDefaultGatewayAddress(const Tizen::Net::IpAddress* pAddress);
-
- /**
- * Gets the primary DNS address in the static address scheme.
- *
- * @since 2.0
- *
- * @return The primary DNS address configured to this access point, @n
- * else @c null if an error occurs or there is no previously set address
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see SetPrimaryDnsAddress()
- */
- const Tizen::Net::IpAddress* GetPrimaryDnsAddress(void) const;
-
- /**
- * Sets the primary DNS address in the static address scheme.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] pAddress The new address to assign
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The existing primary DNS address is unset when the input argument is @c null.
- * @see GetPrimaryDnsAddress()
- */
- result SetPrimaryDnsAddress(const Tizen::Net::IpAddress* pAddress);
-
- /**
- * Gets the secondary DNS address in the static address scheme.
- *
- * @since 2.0
- *
- * @return The secondary DNS address configured to this access point, @n
- * else @c null if an error occurs or there is no previously set address
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see SetSecondaryDnsAddress()
- */
- const Tizen::Net::IpAddress* GetSecondaryDnsAddress(void) const;
-
- /**
- * Sets the secondary DNS address in the static address scheme.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] pAddress The new address to assign
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
- * @remarks The existing secondary DNS address is unset when the input argument is @c null.
- * @see GetSecondaryDnsAddress()
- */
- result SetSecondaryDnsAddress(const Tizen::Net::IpAddress* pAddress);
-
- /**
- * Gets the proxy type.
- *
- * @since 2.0
- *
- * @return The proxy type
- * @see SetProxyType()
- */
- Tizen::Net::NetProxyType GetProxyType(void) const;
-
- /**
- * Sets the proxy type.
- *
- * @since 2.0
- *
- * @param[in] type The proxy type
- * @see GetProxyType()
- */
- void SetProxyType(Tizen::Net::NetProxyType type);
-
- /**
- * Gets the proxy address.
- *
- * @since 2.0
- *
- * @return The proxy address, @n
- * else an empty string if an error occurs or there is no previously set address
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the specified input type is @c NET_PROXY_TYPE_NONE.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see SetProxyAddress()
- */
- Tizen::Base::String GetProxyAddress(void) const;
-
- /**
- * Sets the proxy address.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] address The proxy address
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation.
- * For example, the specified input type is @c NET_PROXY_TYPE_NONE.
- * @remarks The existing proxy address is unset when the input argument is an empty string.
- * @see GetProxyAddress()
- */
- result SetProxyAddress(const Tizen::Base::String& address);
-
- /**
- * Checks whether the specified instance of %WifiBssInfo equals the current instance.
- *
- * @since 2.0
- *
- * @return @c true if the specified instance equals the current instance, @n
- * else @c false
- * @param[in] obj An instance of %WifiBssInfo
- * @remarks The method returns @c false if the specified object is not %WifiBssInfo.
- */
- virtual bool Equals(const Tizen::Base::Object& obj) const;
-
- /**
- * Gets the hash value of the current instance.
- *
- * @since 2.0
- *
- * @return The hash value of the current instance
- */
- virtual int GetHashCode(void) const;
-
- /**
- * Assigns the value of the specified instance to the current instance of %WifiBssInfo.
- *
- * @since 2.0
- *
- * @return The reference of this instance
- * @param[in] rhs An instance of %WifiBssInfo
- */
- WifiBssInfo& operator=(const WifiBssInfo& rhs);
+ *
+ * @since 2.0
+ *
+ * @param[in] scheme The address scheme for the local IP address
+ */
+ void SetLocalAddressScheme(Tizen::Net::NetAddressScheme scheme);
+
+ /**
+ * Gets the local IP address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return The local address configured to this access point, @n
+ * else @c null if an error occurs or there is no previously set address
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see SetLocalAddress()
+ */
+ const Tizen::Net::IpAddress* GetLocalAddress(void) const;
+
+ /**
+ * Sets the local IP address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] pAddress The new address to assign
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation.
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The existing local address is unset when the input argument is @c null.
+ * @see GetLocalAddress()
+ */
+ result SetLocalAddress(const Tizen::Net::IpAddress* pAddress);
+
+ /**
+ * Gets the subnet mask address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return The subnet mask address configured to this access point, @n
+ * else @c null if an error occurs or there is no previously set address
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see SetSubnetMaskAddress()
+ */
+ const Tizen::Net::IpAddress* GetSubnetMaskAddress(void) const;
+
+ /**
+ * Sets the subnet mask address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] pAddress The new address to assign
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The existing subnet mask address is unset when the input argument is @c null.
+ * @see GetSubnetMaskAddress()
+ */
+ result SetSubnetMaskAddress(const Tizen::Net::IpAddress* pAddress);
+
+ /**
+ * Gets the default gateway address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return The default gateway address configured to this access point, @n
+ * else @c null if an error occurs or there is no previously set address
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see SetDefaultGatewayAddress()
+ */
+ const Tizen::Net::IpAddress* GetDefaultGatewayAddress(void) const;
+
+ /**
+ * Sets the default gateway address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] pAddress The new address to assign
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The existing gateway address is unset when the input argument is @c null.
+ * @see GetDefaultGatewayAddress()
+ */
+ result SetDefaultGatewayAddress(const Tizen::Net::IpAddress* pAddress);
+
+ /**
+ * Gets the primary DNS address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return The primary DNS address configured to this access point, @n
+ * else @c null if an error occurs or there is no previously set address
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see SetPrimaryDnsAddress()
+ */
+ const Tizen::Net::IpAddress* GetPrimaryDnsAddress(void) const;
+
+ /**
+ * Sets the primary DNS address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] pAddress The new address to assign
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The existing primary DNS address is unset when the input argument is @c null.
+ * @see GetPrimaryDnsAddress()
+ */
+ result SetPrimaryDnsAddress(const Tizen::Net::IpAddress* pAddress);
+
+ /**
+ * Gets the secondary DNS address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return The secondary DNS address configured to this access point, @n
+ * else @c null if an error occurs or there is no previously set address
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see SetSecondaryDnsAddress()
+ */
+ const Tizen::Net::IpAddress* GetSecondaryDnsAddress(void) const;
+
+ /**
+ * Sets the secondary DNS address in the static address scheme.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] pAddress The new address to assign
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the address scheme for the IP address is @c NET_ADDRESS_SCHEME_DYNAMIC.
+ * @remarks The existing secondary DNS address is unset when the input argument is @c null.
+ * @see GetSecondaryDnsAddress()
+ */
+ result SetSecondaryDnsAddress(const Tizen::Net::IpAddress* pAddress);
+
+ /**
+ * Gets the proxy type.
+ *
+ * @since 2.0
+ *
+ * @return The proxy type
+ * @see SetProxyType()
+ */
+ Tizen::Net::NetProxyType GetProxyType(void) const;
+
+ /**
+ * Sets the proxy type.
+ *
+ * @since 2.0
+ *
+ * @param[in] type The proxy type
+ * @see GetProxyType()
+ */
+ void SetProxyType(Tizen::Net::NetProxyType type);
+
+ /**
+ * Gets the proxy address.
+ *
+ * @since 2.0
+ *
+ * @return The proxy address, @n
+ * else an empty string if an error occurs or there is no previously set address
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the specified input type is @c NET_PROXY_TYPE_NONE.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @see SetProxyAddress()
+ */
+ Tizen::Base::String GetProxyAddress(void) const;
+
+ /**
+ * Sets the proxy address.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] address The proxy address
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation.
+ * For example, the specified input type is @c NET_PROXY_TYPE_NONE.
+ * @remarks The existing proxy address is unset when the input argument is an empty string.
+ * @see GetProxyAddress()
+ */
+ result SetProxyAddress(const Tizen::Base::String& address);
+
+ /**
+ * Checks whether the specified instance of %WifiBssInfo equals the current instance.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the specified instance equals the current instance, @n
+ * else @c false
+ * @param[in] obj An instance of %WifiBssInfo
+ * @remarks The method returns @c false if the specified object is not %WifiBssInfo.
+ */
+ virtual bool Equals(const Tizen::Base::Object& obj) const;
+
+ /**
+ * Gets the hash value of the current instance.
+ *
+ * @since 2.0
+ *
+ * @return The hash value of the current instance
+ */
+ virtual int GetHashCode(void) const;
+
+ /**
+ * Assigns the value of the specified instance to the current instance of %WifiBssInfo.
+ *
+ * @since 2.0
+ *
+ * @return The reference of this instance
+ * @param[in] rhs An instance of %WifiBssInfo
+ */
+ WifiBssInfo& operator=(const WifiBssInfo& rhs);
private:
- _WifiBssInfoImpl *__pWifiBssInfoImpl;
+ _WifiBssInfoImpl *__pWifiBssInfoImpl;
-friend class _WifiBssInfoImpl;
+ friend class _WifiBssInfoImpl;
}; // WifiBssInfo
} } } //Tizen::Net::Wifi
// limitations under the License.
//
/**
- * @file FNetWifiWifiDirectDevice.h
- * @brief This is the header file for the %WifiDirectDevice class.
+ * @file FNetWifiWifiDirectDevice.h
+ * @brief This is the header file for the %WifiDirectDevice class.
*
* This header file contains the declarations of the %WifiDirectDevice class.
*/
* scan Wi-Fi Direct devices, associate a Wi-Fi Direct group owner, create a WifiDirectGroupMember instance,
* and allow the listener to get events related to a Wi-Fi Direct device and group.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
*/
class _OSP_EXPORT_ WifiDirectDevice
: public Tizen::Base::Object
{
public:
- /**
- *
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
- virtual ~WifiDirectDevice(void);
-
- /**
- * Adds a listener for Wi-Fi Direct device.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] listener A reference to the listener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_ALREADY_EXIST The listener is already added.
- */
- result AddWifiDirectDeviceListener(IWifiDirectDeviceListener& listener);
-
- /**
- * @if OSPDEPREC
- * Adds a listener for the Wi-Fi Direct group owner.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method also is deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
-
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] listener A reference to the IWifiDirectGroupOwnerListener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_ALREADY_EXIST The listener is already added.
- * @endif
- */
- result AddWifiDirectGroupOwnerListener(IWifiDirectGroupOwnerListener& listener);
-
- /**
- * @if OSPDEPREC
- * Adds a listener for the Wi-Fi Direct group client.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupClient class is deprecated, therefore, this method also is deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] listener A reference to the IWifiDirectGroupClientListener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_ALREADY_EXIST The listener is already added.
- * @endif
- */
- result AddWifiDirectGroupClientListener(IWifiDirectGroupClientListener& listener);
-
- /**
- * Removes a listener for the Wi-Fi Direct device.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] listener A reference to the IWifiDirectDeviceListener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND The specified object is not found within the indicated range.
- */
- result RemoveWifiDirectDeviceListener(IWifiDirectDeviceListener& listener);
-
- /**
- * @if OSPDEPREC
- * Removes a listener for the Wi-Fi Direct group owner.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method also is deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- * @since 2.0
- *
- * @return An error code
- * @param[in] listener A reference to the IWifiDirectGroupOwnerListener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND The specified object is not found within the indicated range.
- * @endif
- */
- result RemoveWifiDirectGroupOwnerListener(IWifiDirectGroupOwnerListener& listener);
-
- /**
- * @if OSPDEPREC
- * Removes a listener for the Wi-Fi Direct group client.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupClient class is deprecated, therefore, this method also is deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
+ /**
+ *
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
+ virtual ~WifiDirectDevice(void);
+
+ /**
+ * Adds a listener for Wi-Fi Direct device.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] listener A reference to the listener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
+ */
+ result AddWifiDirectDeviceListener(IWifiDirectDeviceListener& listener);
+
+ /**
+ * @if OSPDEPREC
+ * Adds a listener for the Wi-Fi Direct group owner.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method also is deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] listener A reference to the IWifiDirectGroupOwnerListener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
+ * @endif
+ */
+ result AddWifiDirectGroupOwnerListener(IWifiDirectGroupOwnerListener& listener);
+
+ /**
+ * @if OSPDEPREC
+ * Adds a listener for the Wi-Fi Direct group client.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupClient class is deprecated, therefore, this method also is deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] listener A reference to the IWifiDirectGroupClientListener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
+ * @endif
+ */
+ result AddWifiDirectGroupClientListener(IWifiDirectGroupClientListener& listener);
+
+ /**
+ * Removes a listener for the Wi-Fi Direct device.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] listener A reference to the IWifiDirectDeviceListener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OBJ_NOT_FOUND The specified object is not found within the indicated range.
+ */
+ result RemoveWifiDirectDeviceListener(IWifiDirectDeviceListener& listener);
+
+ /**
+ * @if OSPDEPREC
+ * Removes a listener for the Wi-Fi Direct group owner.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method also is deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] listener A reference to the IWifiDirectGroupOwnerListener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OBJ_NOT_FOUND The specified object is not found within the indicated range.
+ * @endif
+ */
+ result RemoveWifiDirectGroupOwnerListener(IWifiDirectGroupOwnerListener& listener);
+
+ /**
+ * @if OSPDEPREC
+ * Removes a listener for the Wi-Fi Direct group client.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupClient class is deprecated, therefore, this method also is deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] listener A reference to the IWifiDirectGroupClientListener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OBJ_NOT_FOUND The specified object is not found within the indicated range.
+ * @endif
+ */
+ result RemoveWifiDirectGroupClientListener(IWifiDirectGroupClientListener& listener);
+
+ /**
+ * Activates the local Wi-Fi device by using the Wi-Fi Direct enabled.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The activation is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The activate process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the Wi-Fi Direct device is already activated.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiDirectDeviceListener::OnWifiDirectDeviceActivated()
+ */
+ result Activate(void);
+
+ /**
+ * Checks whether the local device is activated.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the local device is activated, @n
+ * else @c false
+ * @exception E_SUCCESS The hidden mode is set successfully.
+ * @exception E_SYSTEM A system error has occurred.
+ */
+ bool IsActivated(void) const;
+
+ /**
+ * Deactivates the local Wi-Fi device.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The deactivation is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The deactivate process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the Wi-Fi Direct device is already deactivated.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ *
+ * @see IWifiDirectDeviceListener::OnWifiDirectDeviceDeactivated()
+ */
+ result Deactivate(void);
+
+ /**
+ * Gets the current setting information of a Wi-Fi Direct group.
+ *
+ * @since 2.0
+ *
+ * @return The Wi-Fi Direct group information if successful, @n
+ * else @c null
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
+ WifiDirectGroupInfo* GetGroupSettingInfoN(void) const;
+
+ /**
+ * Gets the current setting information of a Wi-Fi Direct device.
+ *
+ * @since 2.0
+ *
+ * @return The Wi-Fi Direct device information if successful, @n
+ * else @c null
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
+ WifiDirectDeviceInfo* GetLocalDeviceInfoN(void) const;
+
+ /**
+ * Gets the preferred method for the Wi-Fi Protected Setup (WPS) configuration.
+ *
* @since 2.0
- *
- * @return An error code
- * @param[in] listener A reference to the IWifiDirectGroupClientListener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND The specified object is not found within the indicated range.
- * @endif
- */
- result RemoveWifiDirectGroupClientListener(IWifiDirectGroupClientListener& listener);
-
- /**
- * Activates the local Wi-Fi device by using the Wi-Fi Direct enabled.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The activation is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The activate process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the Wi-Fi Direct device is already activated.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiDirectDeviceListener::OnWifiDirectDeviceActivated()
- */
- result Activate(void);
-
- /**
- * Checks whether the local device is activated.
- *
- * @since 2.0
- *
- * @return @c true if the local device is activated, @n
- * else @c false
- * @exception E_SUCCESS The hidden mode is set successfully.
- * @exception E_SYSTEM A system error has occurred.
- */
- bool IsActivated(void) const;
-
- /**
- * Deactivates the local Wi-Fi device.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The deactivation is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The deactivate process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the Wi-Fi Direct device is already deactivated.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- *
- * @see IWifiDirectDeviceListener::OnWifiDirectDeviceDeactivated()
- */
- result Deactivate(void);
-
- /**
- * Gets the current setting information of a Wi-Fi Direct group.
- *
- * @since 2.0
- *
- * @return The Wi-Fi Direct group information if successful, @n
- * else @c null
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
- WifiDirectGroupInfo* GetGroupSettingInfoN(void) const;
-
- /**
- * Gets the current setting information of a Wi-Fi Direct device.
- *
- * @since 2.0
- *
- * @return The Wi-Fi Direct device information if successful, @n
- * else @c null
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
- WifiDirectDeviceInfo* GetLocalDeviceInfoN(void) const;
-
- /**
- * Gets the preferred method for the Wi-Fi Protected Setup (WPS) configuration.
- *
- * @since 2.0
- *
- * @return The preferred configuration mode for WPS
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @c WIFI_WPS_CONFIG_MODE_NONE will be returned in case of the E_SYSTEM exception.
- */
- WifiWpsConfigurationMode GetWpsConfigurationModePreference(void) const;
-
- /**
- * Sets the name of a local device.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] name The name for a local device
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_ARG The specified device name is an empty string.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the Wi-Fi Direct device is already activated.
- * @remarks This method does not affect the system setting and the device name is only valid during the
- * group lifetime. @n
- * When an application in the deactivated state calls this method, the peer devices
- * detect the device specified in the @c name parameter.
- * For example, use this method before using Activate(). @n
- * The specified device name is automatically truncated if its size is greater than @c 64 bytes.
- */
- result SetLocalDeviceName(const Tizen::Base::String& name);
-
- /**
- * Sets the preferred method for the WPS configuration.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] mode The preferred mode for the WPS configuration
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the Wi-Fi Direct device is a group member.
- * @remarks The preferred configuration mode of the system is the PIN-DISPLAY method. @n
- * This method can change the preferred configuration method for the WPS procedure.
- * If the remote device does not support the specified configuration method,
- * the common configuration method is selected between the two devices automatically.
- * Therefore, this method does not guarantee the use of specified WPS configuration method. @n
- * Before calling Connect() method, the user preferred WPS configuration mode should be specified using the SetWpsConfigurationModePreference() method.
- */
- result SetWpsConfigurationModePreference(WifiWpsConfigurationMode mode);
-
- /**
- * @if OSPDEPREC
- * Creates a Wi-Fi Direct group by negotiating with the specified Wi-Fi Direct device for the group owner.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs.
- * Instead of using this method, use the Connect() or CreateAutonomousGroup() method.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @param[in] pWifiDirectGroupInfo The pointer of a WiFiDirectGroupInfo
- * @param[in] pWifiDirectRemoteDeviceInfo The pointer of a WiFiDirectDeviceInfo
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_ARG The specified @c pWifiDirectRemoteDeviceInfo contains an invalid argument.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the Wi-Fi Direct group is already created.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks It is not mandatory for this method to contain values in both the parameters. @n
- * If @c pWifiDirectGroupInfo is specified and the group is created with the specified group configuration information,
- * this group configuration information is valid until the group is destroyed.
- * If @c pWifiDirectGroupInfo is not specified, the Wi-Fi Direct group is created as per the default system configuration settings. @n
- * If @c pWifiDirectRemoteDeviceInfo is not specified, the Wi-Fi Direct group is created with the
- * first found device having the same local device name.
- * Use the SetLocalDeviceName() method to set the device name before activation. @n
- * To obtain a list of Wi-Fi Direct devices which can be candidates for the @c pWifiDirectRemoteDeviceInfo
- * parameter, use the Scan() method prior using this method.
- * To connect a specified Wi-Fi Direct group owner directly, the Scan() and Associate() methods can be used. @n
- * Before this method is called, the event listeners should be added in order to ensure the completion of
- * group creation and to process the request as a group owner or client. @n
- * If the autonomous group owner mode is set to @c true in the specified @c pWifiDirectGroupInfo parameter,
- * @c pWifiDirectRemoteDeviceInfo should be set to @c null and IWifiDirectGroupClientListener would not be required.
- * @see IWifiDirectDeviceListener::OnWifiDirectGroupCreatedN()
- * @endif
- */
- result CreateGroup(const WifiDirectGroupInfo* pWifiDirectGroupInfo = null, const WifiDirectDeviceInfo* pWifiDirectRemoteDeviceInfo = null);
-
- /**
- * @if OSPDEPREC
- * Cancels Wi-Fi Direct group creation.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs. @n
- * Instead of using this method, use the CancelConnect() method.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, when there is no group being created.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see CreateGroup()
- * @see IWifiDirectDeviceListener::OnWifiDirectGroupCreatedN()
+ *
+ * @return The preferred configuration mode for WPS
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @c WIFI_WPS_CONFIG_MODE_NONE will be returned in case of the E_SYSTEM exception.
+ */
+ WifiWpsConfigurationMode GetWpsConfigurationModePreference(void) const;
+
+ /**
+ * Sets the name of a local device.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] name The name for a local device
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_ARG The specified device name is an empty string.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the Wi-Fi Direct device is already activated.
+ * @remarks
+ * - This method does not affect the system setting and the device name is only valid during the
+ * group lifetime.
+ * - When an application in the deactivated state calls this method, the peer devices detect the
+ * device specified in the @c name parameter. For example, use this method before using Activate().
+ * - The specified device name is automatically truncated if its size is greater than @c 64 bytes.
+ */
+ result SetLocalDeviceName(const Tizen::Base::String& name);
+
+ /**
+ * Sets the preferred method for the WPS configuration.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] mode The preferred mode for the WPS configuration
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the Wi-Fi Direct device is a group member.
+ * @remarks
+ * - The preferred configuration mode of the system is the Push Button Configuration (PBC) method.
+ * - If the remote device does not support the specified configuration method, the common
+ * configuration method is selected between the two devices automatically. Therefore, this method
+ * does not guarantee the use of specified WPS configuration method.
+ * - Before calling Connect() method, the user preferred WPS configuration mode should be specified
+ * using the SetWpsConfigurationModePreference() method.
+ */
+ result SetWpsConfigurationModePreference(WifiWpsConfigurationMode mode);
+
+ /**
+ * @if OSPDEPREC
+ * Creates a Wi-Fi Direct group by negotiating with the specified Wi-Fi Direct device for the group owner.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs. @n
+ * Instead of using this method, use the Connect() or CreateAutonomousGroup() method.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @param[in] pWifiDirectGroupInfo The pointer of a WiFiDirectGroupInfo
+ * @param[in] pWifiDirectRemoteDeviceInfo The pointer of a WiFiDirectDeviceInfo
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_ARG The specified @c pWifiDirectRemoteDeviceInfo contains an invalid argument.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the Wi-Fi Direct group is already created.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - It is not mandatory for this method to contain values in both the parameters.
+ * - If @c pWifiDirectGroupInfo is specified and the group is created with the specified group
+ * configuration information, this group configuration information is valid until the group is
+ * destroyed.If @c pWifiDirectGroupInfo is not specified, the Wi-Fi Direct group is created as per
+ * the default system configuration settings.
+ * - If @c pWifiDirectRemoteDeviceInfo is not specified, the Wi-Fi Direct group is created with the
+ * first found device having the same local device name.
+ * - Use the SetLocalDeviceName() method to set the device name before activation.
+ * - To obtain a list of Wi-Fi Direct devices which can be candidates for the
+ * @c pWifiDirectRemoteDeviceInfo parameter, use the Scan() method prior using this method.
+ * - To connect a specified Wi-Fi Direct group owner directly, the Scan() and Associate() methods can
+ * be used.
+ * - Before this method is called, the event listeners should be added in order to ensure the
+ * completion of group creation and to process the request as a group owner or client.
+ * - If the autonomous group owner mode is set to @c true in the specified @c pWifiDirectGroupInfo
+ * parameter, @c pWifiDirectRemoteDeviceInfo should be set to @c null and
+ * IWifiDirectGroupClientListener would not be required.
+ * @see IWifiDirectDeviceListener::OnWifiDirectGroupCreatedN()
+ * @endif
+ */
+ result CreateGroup(const WifiDirectGroupInfo* pWifiDirectGroupInfo = null, const WifiDirectDeviceInfo* pWifiDirectRemoteDeviceInfo = null);
+
+ /**
+ * @if OSPDEPREC
+ * Cancels Wi-Fi Direct group creation.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs. @n
+ * Instead of using this method, use the CancelConnect() method.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, when there is no group being created.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see CreateGroup()
+ * @see IWifiDirectDeviceListener::OnWifiDirectGroupCreatedN()
+ * @endif
+ */
+ result CancelGroupCreation(void);
+
+ /**
+ * Scans Wi-Fi Direct Devices which are in the specified type.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.read
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the Wi-Fi Direct device is deactivated.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks This operation does not work while the Wi-Fi connection to the AP is in progress or established.
+ * @see IWifiDirectDeviceListener::OnWifiDirectScanCompletedN()
+ */
+ result Scan(void);
+
+ /**
+ * Cancels the Wi-Fi Direct previous scan operation.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.read
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the scan operation is not in process.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiDirectDeviceListener::OnWifiDirectScanCompletedN()
+ */
+ result CancelScan(void);
+
+ /**
+ * @if OSPDEPREC
+ * Establishes a connection with a specific group owner.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs. @n
+ * Instead of using this method, use the Connect() method.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @param[in] wifiDirectGroupOwnerDeviceInfo The WifiDirectDeviceInfo value of a group owner
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request or group creation is in progress.
+ * @exception E_INVALID_ARG The specified @c wifiDirectGroupOwnerDeviceInfo contains an invalid argument.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the member type of a device is already a group owner or client.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks If a connection is already established with other device, the previous connection should be disconnected
+ * before using this method.
+ * @see IWifiDirectDeviceListener::OnWifiDirectAssociationCompleted()
+ * @endif
+ */
+ result Associate(const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo);
+
+ /**
+ * @if OSPDEPREC
+ * Gets the Wi-Fi Direct member instance.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs.
+ *
+ * @since 2.0
+ *
+ * @return The Wi-Fi Direct member instance if successful, @n
+ * else @c null if the status of device is @c WIFI_DIRECT_GROUP_MEMBER_TYPE_NONE
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the member type of a device is not a group owner or client.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
- */
- result CancelGroupCreation(void);
-
- /**
- * Scans Wi-Fi Direct Devices which are in the specified type.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.read
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the Wi-Fi Direct device is deactivated.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks This operation does not work while the Wi-Fi connection to the AP is in progress or established.
- * @see IWifiDirectDeviceListener::OnWifiDirectScanCompletedN()
- */
- result Scan(void);
-
- /**
- * Cancels the Wi-Fi Direct previous scan operation.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.read
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the scan operation is not in process.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiDirectDeviceListener::OnWifiDirectScanCompletedN()
- */
- result CancelScan(void);
-
- /**
- * @if OSPDEPREC
- * Establishes a connection with a specific group owner.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs. @n
- * Instead of using this method, use the Connect() method.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @param[in] wifiDirectGroupOwnerDeviceInfo The WifiDirectDeviceInfo value of a group owner
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request or group creation is in progress.
- * @exception E_INVALID_ARG The specified @c wifiDirectGroupOwnerDeviceInfo contains an invalid argument.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the member type of a device is already a group owner or client.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks If a connection is already established with other device, the previous connection should be disconnected
- * before using this method.
- * @see IWifiDirectDeviceListener::OnWifiDirectAssociationCompleted()
- * @endif
- */
- result Associate(const WifiDirectDeviceInfo& wifiDirectGroupOwnerDeviceInfo);
-
- /**
- * @if OSPDEPREC
- * Gets the Wi-Fi Direct member instance.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs.
- *
- * @since 2.0
- *
- * @return The Wi-Fi Direct member instance if successful, @n
- * else @c null if the status of device is @c WIFI_DIRECT_GROUP_MEMBER_TYPE_NONE
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the member type of a device is not a group owner or client.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @endif
- */
- WifiDirectGroupMember* GetWifiDirectMemberN(void) const;
-
- /**
- * Checks whether the local Wi-Fi Direct device is currently discoverable.
- *
- * @since 2.0
- *
- * @return @c true if the local Wi-Fi Direct device is currently discoverable, @n
- * else @c false
- * @remarks At times, even though the Wi-Fi Direct device is activated the device cannot be discovered due to the visibility
- * setting, or if the device is performing some operation, such as Wi-Fi scanning.
- */
- bool IsDiscoverable(void) const;
-
- /**
- * Connects to the Wi-Fi Direct connection with the specified peer device.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @param[in] remoteDeviceInfo The remote peer device to connect.
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The previous request is in progress.
- * @exception E_INVALID_ARG The specified @c remoteDeviceInfo is invalid.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is already connected except in the case of group owner.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- *
- * @remarks If the local device does not belong to a group owner or client, a group negotiation request is sent to the remote device and the configured group information is used at this time. @n
- * If the local device is a group owner, a request to join the group is sent to the remote device.
- *
- * @see IWifiDirectDeviceListener::OnWifiDirectConnected()
- * @see SetGroupSettingInfo()
- * @see SetWpsConfigurationModePreference()
- */
- result Connect(const WifiDirectDeviceInfo& remoteDeviceInfo);
-
- /**
- * Cancels the request for Wi-Fi Direct connection.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is not connecting.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- *
- * @see IWifiDirectDeviceListener::OnWifiDirectConnected()
- */
- result CancelConnect(void);
-
- /**
- * Creates a Wi-Fi Direct group as the group owner.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is already deactivated or connected.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- *
- * @see IWifiDirectDeviceListener::OnWifiDirectAutonomousGroupCreated()
- *
- */
- result CreateAutonomousGroup(void);
-
- /**
- * Sets the configuration information of a Wi-Fi Direct group.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @param[in] groupSettingInfo The group setting information
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is already deactivated or connected.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- *
- * @remarks This method should be called before using Connect() to configure the group information.
- */
- result SetGroupSettingInfo(const WifiDirectGroupInfo& groupSettingInfo);
-
- /**
- * Disconnects the specified peer device.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @param[in] peerDeviceInfo The peer device to disconnect
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The previous request is in progress.
- * @exception E_INVALID_ARG The specified @c remoteDeviceInfo is invalid.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is not connected.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- *
- * @see IWifiDirectDeviceListener::OnWifiDirectDisconnected()
- */
- result Disconnect(const WifiDirectDeviceInfo& peerDeviceInfo);
-
- /**
- * Leaves the currently participating Wi-Fi Direct group.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is not a group owner or client.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- *
- * @see IWifiDirectDeviceListener::OnWifiDirectGroupLeft()
- * @remarks If the local device belongs to a group owner, the group will be destroyed and the IWifiDirectDeviceListener::OnWifiDirectDisconnected() event method will not occur for each client connection.
- */
- result LeaveGroup(void);
-
-
- /**
- * Gets information of the group owner of a Wi-Fi Direct group.
- *
- * @since 2.0
- *
- * @return The Wi-Fi Direct group owner information if successful, @n
- * else null
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is not connected.
- * @remarks The specific error code can be accessed using the GetLastResult() method
- */
- WifiDirectDeviceInfo* GetGroupOwnerInfoN(void) const;
-
- /**
- * Gets the list of the Wi-Fi Direct group clients.
- *
- * @since 2.0
- *
- * @return A pointer to the list that contains the WifiDirectDeviceInfo instances of the group clients if successful, @n
- * else @c null
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, the local device is not a group owner.
- */
- Tizen::Base::Collection::IList* GetGroupClientInfoListN(void) const;
-
- /**
- * Gets the index of a currently working channel.
- *
- * @since 2.0
- *
- * @return The Wi-Fi radio channel
- *
- * @remarks If the member type of the local device is not a group owner or client, the channel does not contain valid information.
- */
- WifiRadioChannel GetOperatingChannel(void) const;
+ */
+ WifiDirectGroupMember* GetWifiDirectMemberN(void) const;
+
+ /**
+ * Checks whether the local Wi-Fi Direct device is currently discoverable.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the local Wi-Fi Direct device is currently discoverable, @n
+ * else @c false
+ */
+ bool IsDiscoverable(void) const;
+
+ /**
+ * Connects to the Wi-Fi Direct connection with the specified peer device.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @param[in] remoteDeviceInfo The remote peer device to connect.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The previous request is in progress.
+ * @exception E_INVALID_ARG The specified @c remoteDeviceInfo is invalid.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is already connected except in the case of group
+ * owner.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ *
+ * @remarks
+ * - If the local device does not belong to a group owner or client, a group negotiation request is
+ * sent to the remote device and the configured group information is used at this time.
+ * - If the local device is a group owner, a request to join the group is sent to the remote device.
+ *
+ * @see IWifiDirectDeviceListener::OnWifiDirectConnected()
+ * @see SetGroupSettingInfo()
+ * @see SetWpsConfigurationModePreference()
+ */
+ result Connect(const WifiDirectDeviceInfo& remoteDeviceInfo);
+
+ /**
+ * Cancels the request for Wi-Fi Direct connection.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is not connecting.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ *
+ * @see IWifiDirectDeviceListener::OnWifiDirectConnected()
+ */
+ result CancelConnect(void);
+
+ /**
+ * Creates a Wi-Fi Direct group as the group owner.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is already deactivated or connected.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ *
+ * @see IWifiDirectDeviceListener::OnWifiDirectAutonomousGroupCreated()
+ *
+ */
+ result CreateAutonomousGroup(void);
+
+ /**
+ * Sets the configuration information of a Wi-Fi Direct group.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @param[in] groupSettingInfo The group setting information
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is already deactivated or connected.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ *
+ * @remarks This method should be called before using Connect() to configure the group information.
+ */
+ result SetGroupSettingInfo(const WifiDirectGroupInfo& groupSettingInfo);
+
+ /**
+ * Disconnects the specified peer device.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @param[in] peerDeviceInfo The peer device to disconnect
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The previous request is in progress.
+ * @exception E_INVALID_ARG The specified @c remoteDeviceInfo is invalid.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is not connected.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ *
+ * @see IWifiDirectDeviceListener::OnWifiDirectDisconnected()
+ */
+ result Disconnect(const WifiDirectDeviceInfo& peerDeviceInfo);
+
+ /**
+ * Leaves the currently participating Wi-Fi Direct group.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is not a group owner or client.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ *
+ * @see IWifiDirectDeviceListener::OnWifiDirectGroupLeft()
+ * @remarks If the local device belongs to a group owner, the group will be destroyed and the
+ * IWifiDirectDeviceListener::OnWifiDirectDisconnected() event method will not occur for each client
+ * connection.
+ */
+ result LeaveGroup(void);
+
+
+ /**
+ * Gets information of the group owner of a Wi-Fi Direct group.
+ *
+ * @since 2.0
+ *
+ * @return The Wi-Fi Direct group owner information if successful, @n
+ * else null
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is not connected.
+ * @remarks The specific error code can be accessed using the GetLastResult() method
+ */
+ WifiDirectDeviceInfo* GetGroupOwnerInfoN(void) const;
+
+ /**
+ * Gets the list of the Wi-Fi Direct group clients.
+ *
+ * @since 2.0
+ *
+ * @return A pointer to the list that contains the WifiDirectDeviceInfo instances of the group clients if
+ * successful, @n
+ * else @c null
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, the local device is not a group owner.
+ */
+ Tizen::Base::Collection::IList* GetGroupClientInfoListN(void) const;
+
+ /**
+ * Gets the index of a currently working channel.
+ *
+ * @since 2.0
+ *
+ * @return The Wi-Fi radio channel
+ *
+ * @remarks If the member type of the local device is not a group owner or client, the channel does not contain
+ * valid information.
+ */
+ WifiRadioChannel GetOperatingChannel(void) const;
private:
- /**
- *
- * This default constructor is intentionally declared as private so that only the platform can create an instance.
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly
- * to initialize this instance.
- * @see Construct()
- */
- WifiDirectDevice(void);
-
- /**
- * This copy constructor is intentionally declared as private to prohibit copying of objects by users.
- *
- * @param[in] value An instance of %WifiDirectDevice
- */
- WifiDirectDevice(const WifiDirectDevice& value);
-
- /**
- * Initializes this instance of %WifiDirectDevice.
- *
- * @return An error code
- * @param[in] localDeviceId An ID for a Wi-Fi Direct device
- *
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c localDeviceId is invalid.
- */
- result Construct(WifiDirectDeviceId localDeviceId);
-
- /**
- * The implementation of this copy assignment operator is intentionally blank and declared as private to
- * prohibit copying of objects.
- *
- * @param[in] rhs An instance of %WifiDirectDevice
- */
- WifiDirectDevice& operator =(const WifiDirectDevice& rhs);
+ //
+ // This default constructor is intentionally declared as private so that only the platform can create an instance.
+ //
+ WifiDirectDevice(void);
+
+ //
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectDevice(const WifiDirectDevice& value);
+
+ //
+ // Initializes this instance of %WifiDirectDevice. @n
+ // This method is intentionally declared as private so that only the platform can initialize the instance.
+ //
+ result Construct(WifiDirectDeviceId localDeviceId);
+
+ //
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectDevice& operator =(const WifiDirectDevice& rhs);
private:
- _WifiDirectDeviceImpl* __pWifiDirectDeviceImpl;
+ _WifiDirectDeviceImpl* __pWifiDirectDeviceImpl;
- friend class _WifiDirectDeviceImpl;
+ friend class _WifiDirectDeviceImpl;
}; // WifiDirectDevice
} } } // Tizen::Net::Wifi
: public Tizen::Base::Object
{
public:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- */
- WifiDirectDeviceInfo(void);
-
- /**
- * Copying of objects using this copy constructor is allowed.
- *
- * @since 2.0
- *
- * @param[in] value An instance of %WifiDirectDeviceInfo
- */
- WifiDirectDeviceInfo(const WifiDirectDeviceInfo& value);
-
- /**
- * Initializes this instance of %WifiDirectDeviceInfo with the specified device name
- * and the MAC address.
- *
- * @since 2.0
- *
- * @param[in] deviceName The device name @n
- * The length of @c deviceName must not exceed 64 characters.
- * @param[in] macAddr The MAC address @n
- * The value of @c macAddr must be in the form '00-00-00-00-00-00'.
- *
- */
- WifiDirectDeviceInfo(const Tizen::Base::String& deviceName, const Tizen::Base::String& macAddr);
-
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
- virtual ~WifiDirectDeviceInfo(void);
-
- /**
- * Gets the ID of the device.
- *
- * @since 2.0
- *
- * @return The ID of the Wi-Fi Direct device
- * @remarks This value is only available for local device information query, such as WifiDirectDeviceManager::GetAllDeviceInfoN() or WifiDirectDevice::GetLocalDeviceInfoN(). @n
- * When the value is not available, the return value is @c -1.
- */
- WifiDirectDeviceId GetDeviceId(void) const;
-
- /**
- * Gets the device name.
- *
- * @since 2.0
- *
- * @return The device name
- */
- Tizen::Base::String GetDeviceName(void) const;
-
- /**
- * Gets the MAC address of the device.
- *
- * @since 2.0
- *
- * @return The MAC address in the form '00-00-00-00-00-00'
- * @remarks This MAC address is different from the MAC address provided by the WifiManager or DhcpClientInfo class.
- * Especially, the MAC address which is provided in DhcpClientInfo is a virtual MAC address for data communication during a Wi-Fi Direct group member.
- */
- Tizen::Base::String GetMacAddress(void) const;
-
- /**
- * Gets the IP address of the device.
- *
- * @since 2.0
- *
- * @return An IpAddress pointer to the local address in the calling instance
- * @remarks The IP address is provided only using WifiDirectDevice::GetGroupOwnerInfoN(), WifiDirectDevice::GetGroupClientInfoListN(),
- * or WifiDirectDevice::GetLocalDeviceInfoN() after becoming a group member.
- */
- const Tizen::Net::IpAddress* GetIpAddress(void) const;
-
- /**
- * Gets the SSID.
- *
- * @since 2.0
- *
- * @return The SSID
- * @remarks This method returns an empty string if the member type of a device is not a Wi-Fi Direct group owner or client.
- */
- Tizen::Base::String GetSsid(void) const;
-
- /**
- * Gets the status of the device.
- *
- * @since 2.0
- *
- * @return The status of the Wi-Fi Direct device
- */
- WifiDirectDeviceStatus GetDeviceStatus(void) const;
-
- /**
- * Gets the member type of the Wi-Fi Direct device.
- *
- * @since 2.0
- *
- * @return The member type of the Wi-Fi Direct device
- */
- WifiDirectGroupMemberType GetGroupMemberType(void) const;
-
- /**
- * Gets the category of the Wi-Fi Direct device type.
- *
- * @since 2.0
- *
- * @return The category of the Wi-Fi Direct device type
- */
- WifiDirectDeviceTypeCategory GetDeviceTypeCategory(void) const;
-
- /**
- * Gets the list of supporting WPS configuration modes.
- *
- * @since 2.0
- *
- * @return The list of supporting WPS configuration modes
- * @remarks The result of this method is available only using WifiDirectDevice::Scan() or WifiDirectDevice::GetLocalDeviceInfoN().
- */
- const Tizen::Base::Collection::IListT <WifiWpsConfigurationMode>* GetSupportedWpsConfigurationModeList(void) const;
-
- /**
- * Checks whether the specified instance of %WifiDirectDeviceInfo equals the current instance.
- *
- * @since 2.0
- *
- * @return @c true if the specified instance equals the current instance, @n
- * else @c false
- * @param[in] obj An instance of %WifiDirectDeviceInfo
- * @remarks This method returns @c false if the specified object is not %WifiDirectDeviceInfo.
- */
- virtual bool Equals(const Tizen::Base::Object& obj) const;
-
- /**
- * Gets the hash value of the current instance.
- *
- * @since 2.0
- *
- * @return The hash value of the current instance
- */
- virtual int GetHashCode(void) const;
-
- /**
- * Assigns the value of the specified instance to the current instance of %WifiDirectDeviceInfo.
- *
- * @since 2.0
- *
- * @return A reference to this instance
- * @param[in] rhs An instance of %WifiDirectDeviceInfo
- */
- WifiDirectDeviceInfo& operator =(const WifiDirectDeviceInfo& rhs);
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ */
+ WifiDirectDeviceInfo(void);
+
+ /**
+ * Copying of objects using this copy constructor is allowed.
+ *
+ * @since 2.0
+ *
+ * @param[in] value An instance of %WifiDirectDeviceInfo
+ */
+ WifiDirectDeviceInfo(const WifiDirectDeviceInfo& value);
+
+ /**
+ * Initializes this instance of %WifiDirectDeviceInfo with the specified device name
+ * and the MAC address.
+ *
+ * @since 2.0
+ *
+ * @param[in] deviceName The device name @n
+ * The length of @c deviceName must not exceed 64 characters.
+ * @param[in] macAddr The MAC address @n
+ * The value of @c macAddr must be in the form '00-00-00-00-00-00'.
+ *
+ */
+ WifiDirectDeviceInfo(const Tizen::Base::String& deviceName, const Tizen::Base::String& macAddr);
+
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
+ virtual ~WifiDirectDeviceInfo(void);
+
+ /**
+ * Gets the ID of the device.
+ *
+ * @since 2.0
+ *
+ * @return The ID of the Wi-Fi Direct device
+ * @remarks
+ * - This value is only available for local device information query, such as
+ * WifiDirectDeviceManager::GetAllDeviceInfoN() or WifiDirectDevice::GetLocalDeviceInfoN().
+ * - When the value is not available, the return value is @c -1.
+ */
+ WifiDirectDeviceId GetDeviceId(void) const;
+
+ /**
+ * Gets the device name.
+ *
+ * @since 2.0
+ *
+ * @return The device name
+ */
+ Tizen::Base::String GetDeviceName(void) const;
+
+ /**
+ * Gets the MAC address of the device.
+ *
+ * @since 2.0
+ *
+ * @return The MAC address in the form '00-00-00-00-00-00'
+ * @remarks This MAC address is different from the MAC address provided by the WifiManager or DhcpClientInfo
+ * class. Especially, the MAC address which is provided in DhcpClientInfo is a virtual MAC address for
+ * data communication during a Wi-Fi Direct group member.
+ */
+ Tizen::Base::String GetMacAddress(void) const;
+
+ /**
+ * Gets the IP address of the device.
+ *
+ * @since 2.0
+ *
+ * @return An IpAddress pointer to the local address in the calling instance
+ * @remarks The IP address is provided only using WifiDirectDevice::GetGroupOwnerInfoN(),
+ * WifiDirectDevice::GetGroupClientInfoListN(), or WifiDirectDevice::GetLocalDeviceInfoN() after
+ * becoming a group member.
+ */
+ const Tizen::Net::IpAddress* GetIpAddress(void) const;
+
+ /**
+ * Gets the SSID.
+ *
+ * @since 2.0
+ *
+ * @return The SSID
+ * @remarks This method returns an empty string if the member type of a device is not a Wi-Fi Direct group
+ * owner or client.
+ */
+ Tizen::Base::String GetSsid(void) const;
+
+ /**
+ * Gets the status of the device.
+ *
+ * @since 2.0
+ *
+ * @return The status of the Wi-Fi Direct device
+ */
+ WifiDirectDeviceStatus GetDeviceStatus(void) const;
+
+ /**
+ * Gets the member type of the Wi-Fi Direct device.
+ *
+ * @since 2.0
+ *
+ * @return The member type of the Wi-Fi Direct device
+ */
+ WifiDirectGroupMemberType GetGroupMemberType(void) const;
+
+ /**
+ * Gets the category of the Wi-Fi Direct device type.
+ *
+ * @since 2.0
+ *
+ * @return The category of the Wi-Fi Direct device type
+ */
+ WifiDirectDeviceTypeCategory GetDeviceTypeCategory(void) const;
+
+ /**
+ * Gets the list of supporting WPS configuration modes.
+ *
+ * @since 2.0
+ *
+ * @return The list of supporting WPS configuration modes
+ * @remarks The result of this method is available only using WifiDirectDevice::Scan() or
+ * WifiDirectDevice::GetLocalDeviceInfoN().
+ */
+ const Tizen::Base::Collection::IListT <WifiWpsConfigurationMode>* GetSupportedWpsConfigurationModeList(void) const;
+
+ /**
+ * Checks whether the specified instance of %WifiDirectDeviceInfo equals the current instance.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the specified instance equals the current instance, @n
+ * else @c false
+ * @param[in] obj An instance of %WifiDirectDeviceInfo
+ * @remarks This method returns @c false if the specified object is not %WifiDirectDeviceInfo.
+ */
+ virtual bool Equals(const Tizen::Base::Object& obj) const;
+
+ /**
+ * Gets the hash value of the current instance.
+ *
+ * @since 2.0
+ *
+ * @return The hash value of the current instance
+ */
+ virtual int GetHashCode(void) const;
+
+ /**
+ * Assigns the value of the specified instance to the current instance of %WifiDirectDeviceInfo.
+ *
+ * @since 2.0
+ *
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %WifiDirectDeviceInfo
+ */
+ WifiDirectDeviceInfo& operator =(const WifiDirectDeviceInfo& rhs);
private :
- _WifiDirectDeviceInfoImpl* __pWifiDirectDeviceInfoImpl;
+ _WifiDirectDeviceInfoImpl* __pWifiDirectDeviceInfoImpl;
- friend class _WifiDirectDeviceInfoImpl;
+ friend class _WifiDirectDeviceInfoImpl;
}; // WifiDirectDeviceInfo
} } } // Tizen::Net::Wifi
: public Tizen::Base::Object
{
public:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- */
- WifiDirectDeviceManager(void);
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ */
+ WifiDirectDeviceManager(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
- virtual ~WifiDirectDeviceManager(void);
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
+ virtual ~WifiDirectDeviceManager(void);
- /**
- * Gets a list of all the devices and also their information provided by the system.
- *
- * @since 2.0
- *
- * @feature %http://tizen.org/feature/network.wifi.direct
- *
- * @return A Tizen::Base::Collection::IList containing WifiDirectDeviceInfo of local devices in the system if successful, @n
- * else @c null
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM An internal error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the Wi-Fi Direct feature.
- * For more information, see <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>Application Filtering</a>.
- * @remarks
- * - Currently, a single WifiDirectDeviceInfo instance is returned because the concurrent mode is not supported.
- * - The specific error code can be accessed using the GetLastResult() method.
- * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
- */
- static Tizen::Base::Collection::IList* GetAllDeviceInfoN(void);
+ /**
+ * Gets a list of all the devices and also their information provided by the system.
+ *
+ * @since 2.0
+ *
+ * @feature %http://tizen.org/feature/network.wifi.direct
+ *
+ * @return A Tizen::Base::Collection::IList containing WifiDirectDeviceInfo of local devices in the system if
+ * successful, @n
+ * else @c null
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM An internal error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_UNSUPPORTED_OPERATION The device does not support the Wi-Fi Direct feature. For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
+ * @remarks
+ * - Currently, a single WifiDirectDeviceInfo instance is returned because the concurrent mode is not supported.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Before calling this method, check whether the feature is supported by
+ * %Tizen::System::SystemInfo::GetValue() methods.
+ */
+ static Tizen::Base::Collection::IList* GetAllDeviceInfoN(void);
- /**
- * Gets an instance of WifiDirectDevice.
- *
- * @since 2.0
- *
- * @feature %http://tizen.org/feature/network.wifi.direct
- *
- * @return An instance of WifiDirectDevice if successful, @n
- * else @c null
- * @param[in] pLocalDeviceInfo A pointer to WifiDirectDeviceInfo
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM An internal error has occurred.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the Wi-Fi Direct feature.
- * For more information, see <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>Application Filtering</a>.
- * @remarks
- * - If the value of @c pLocalDeviceInfo is @c null, the WifiDirectDevice instance is created for the system default device.
- * Otherwise, the value of @c pLocalDeviceInfo should be one of the elements obtained
- * from WifiDirectDeviceManager::GetAllDeviceInfoN() to create a valid %WifiDirectDevice instance.
- * - The specific error code can be accessed using the GetLastResult() method.
- * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
- */
- static WifiDirectDevice* GetWifiDirectDeviceN(const WifiDirectDeviceInfo* pLocalDeviceInfo = null);
+ /**
+ * Gets an instance of WifiDirectDevice.
+ *
+ * @since 2.0
+ *
+ * @feature %http://tizen.org/feature/network.wifi.direct
+ *
+ * @return An instance of WifiDirectDevice if successful, @n
+ * else @c null
+ * @param[in] pLocalDeviceInfo A pointer to WifiDirectDeviceInfo
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM An internal error has occurred.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_UNSUPPORTED_OPERATION The device does not support the Wi-Fi Direct feature. For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
+ * @remarks
+ * - If the value of @c pLocalDeviceInfo is @c null, the WifiDirectDevice instance is created for the
+ * system default device. Otherwise, the value of @c pLocalDeviceInfo should be one of the elements
+ * obtained from WifiDirectDeviceManager::GetAllDeviceInfoN() to create a valid %WifiDirectDevice
+ * instance.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - Before calling this method, check whether the feature is supported by
+ * %Tizen::System::SystemInfo::GetValue() methods.
+ */
+ static WifiDirectDevice* GetWifiDirectDeviceN(const WifiDirectDeviceInfo* pLocalDeviceInfo = null);
private:
- /**
- * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] value An instance of %WifiDirectDeviceManager
- */
- WifiDirectDeviceManager(const WifiDirectDeviceManager& value);
+ //
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectDeviceManager(const WifiDirectDeviceManager& value);
- /**
- * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- * copying of objects.
- *
- * @param[in] rhs An instance of %WifiDirectDeviceManager
- */
- WifiDirectDeviceManager& operator =(const WifiDirectDeviceManager& rhs);
+ //
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectDeviceManager& operator =(const WifiDirectDeviceManager& rhs);
private:
- _WifiDirectDeviceManagerImpl* __pWifiDirectDeviceManagerImpl;
+ _WifiDirectDeviceManagerImpl* __pWifiDirectDeviceManagerImpl;
- friend class _WifiDirectDeviceManagerImpl;
+ friend class _WifiDirectDeviceManagerImpl;
}; // WifiDirectDeviceManager
} } } // Tizen::Net::Wifi
/**
* @if OSPDEPREC
- * @class WifiDirectGroupClient
- * @brief <i> [Deprecated] </i> This class provides methods for the Wi-Fi Direct group client management.
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs.
- * As the APIs have been integrated into WifiDirectDevice class, use WifiDirectDevice class instead.
+ * @class WifiDirectGroupClient
+ * @brief <i> [Deprecated] </i> This class provides methods for the Wi-Fi Direct group client management.
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to
+ * use these APIs.@n
+ * As the APIs have been integrated into WifiDirectDevice class, use WifiDirectDevice class instead.
*
- * @since 2.0
+ * @since 2.0
*
* The %WifiDirectGroupClient class provides methods to manage the Wi-Fi Direct client.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
* @endif
*/
: public WifiDirectGroupMember
{
public:
- /**
- * @if OSPDEPREC
- * This is the destructor for this class.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- *
- * @since 2.0
- * @endif
- */
- virtual ~WifiDirectGroupClient(void);
+ /**
+ * @if OSPDEPREC
+ * This is the destructor for this class.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ *
+ * @since 2.0
+ * @endif
+ */
+ virtual ~WifiDirectGroupClient(void);
- /**
- * @if OSPDEPREC
- * Closes the connection.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupClient class is deprecated. Therefore, this method is also deprecated, because previously the Wi-Fi Direct APIs were provided centered on the role(e.g. group owner, group client) @n
- * so it was necessary to use APIs in accordance with the strict role; however, it has been revised to allow using APIs with ease without discerning the role. @n
- * It is integrated into WifiDirectDevice class. Use the WifiDirectDevice::Disconnect() method.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, when the member type of a device is not a Wi-Fi Direct group client.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiDirectGroupClientListener::OnWifiDirectAssociationTerminated()
- * @endif
- */
- result Disassociate(void);
+ /**
+ * @if OSPDEPREC
+ * Closes the connection.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupClient class is deprecated. Therefore, this method is also deprecated, because
+ * previously the Wi-Fi Direct APIs were provided centered on the role(e.g. group owner, group
+ * client). @n
+ * So it was necessary to use APIs in accordance with the strict role; however, it has been revised to
+ * allow using APIs with ease without discerning the role. @n
+ * It is integrated into WifiDirectDevice class. Use the WifiDirectDevice::Disconnect() method.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, when the member type of a device is not a Wi-Fi Direct group client.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiDirectGroupClientListener::OnWifiDirectAssociationTerminated()
+ * @endif
+ */
+ result Disassociate(void);
- /**
- * @if OSPDEPREC
- * Requests the WifiDirectDeviceInfo of the Wi-Fi Direct group owner.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupClient class is deprecated. Therefore, this method is also deprecated, because previously the Wi-Fi Direct APIs were provided centered on the role(e.g. group owner, group client) @n
- * so it was necessary to use APIs in accordance with the strict role; however, it has been revised to allow using APIs with ease without discerning the role. @n
- * Instead of using this method, use the WifiDirectDevice::GetGroupOwnerInfoN() method.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection and %http://tizen.org/privilege/socket @n
- * All the above privileges are required
- *
- * @return An error code
- * @param[in] portNumber A port number to connect to the group member information service
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The previous request for the group owner information is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, when the member type of a device is not a Wi-Fi Direct group client.
- * @exception E_OUT_OF_RANGE The specified port number is less than 1024 or greater than 65535.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The port number used by the group owner must be specified if the group owner changes the port number
- * in WifiDirectGroupOwner::StartGroupMemberInfoService().
- * @see IWifiDirectGroupClientListener::OnWifiDirectGroupOwnerInfoReceived()
- * @endif
- */
- result RequestGroupOwnerInfo(int portNumber = DEFAULT_PORT);
+ /**
+ * @if OSPDEPREC
+ * Requests the WifiDirectDeviceInfo of the Wi-Fi Direct group owner.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupClient class is deprecated. Therefore, this method is also deprecated, because
+ * previously the Wi-Fi Direct APIs were provided centered on the role(e.g. group owner, group
+ * client) @n
+ * so it was necessary to use APIs in accordance with the strict role; however, it has been revised to
+ * allow using APIs with ease without discerning the role. @n
+ * Instead of using this method, use the WifiDirectDevice::GetGroupOwnerInfoN() method.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection
+ * and %http://tizen.org/privilege/socket @n
+ * All the above privileges are required.
+ *
+ * @return An error code
+ * @param[in] portNumber A port number to connect to the group member information service
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The previous request for the group owner information is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, when the member type of a device is not a Wi-Fi Direct group client.
+ * @exception E_OUT_OF_RANGE The specified port number is less than 1024 or greater than 65535.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The port number used by the group owner must be specified if the group owner changes the port number
+ * in WifiDirectGroupOwner::StartGroupMemberInfoService().
+ * @see IWifiDirectGroupClientListener::OnWifiDirectGroupOwnerInfoReceived()
+ * @endif
+ */
+ result RequestGroupOwnerInfo(int portNumber = DEFAULT_PORT);
- /**
- * @if OSPDEPREC
- * Requests the WifiDirectDeviceInfo list of the Wi-Fi Direct group members.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated %WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
+ /**
+ * @if OSPDEPREC
+ * Requests the WifiDirectDeviceInfo list of the Wi-Fi Direct group members.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated %WifiDirectGroupClient class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection
+ * and %http://tizen.org/privilege/socket @n
+ * All the above privileges are required.
*
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection and %http://tizen.org/privilege/socket @n
- * All the above privileges are required
- *
- * @return An error code
- * @param[in] portNumber A port number to connect to the group member information service
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS The previous request for the group owner information is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, when the member type of a device is not a Wi-Fi Direct group client.
- * @exception E_OUT_OF_RANGE The specified port number is less than 1024 or greater than 65535.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The port number used by the group owner should be specified if the group owner changed the port number in WifiDirectGroupOwner::StartGroupMemberInfoService().
- * @see IWifiDirectGroupClientListener::OnWifiDirectAllGroupMemberInfoReceivedN()
- * @endif
- */
- result RequestAllGroupMemberInfo(int portNumber = DEFAULT_PORT);
+ * @return An error code
+ * @param[in] portNumber A port number to connect to the group member information service
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS The previous request for the group owner information is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, when the member type of a device is not a Wi-Fi Direct group client.
+ * @exception E_OUT_OF_RANGE The specified port number is less than 1024 or greater than 65535.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The port number used by the group owner should be specified if the group owner changed the port
+ * number in WifiDirectGroupOwner::StartGroupMemberInfoService().
+ * @see IWifiDirectGroupClientListener::OnWifiDirectAllGroupMemberInfoReceivedN()
+ * @endif
+ */
+ result RequestAllGroupMemberInfo(int portNumber = DEFAULT_PORT);
private:
- /**
- * This default constructor is intentionally declared as private so that only the platform can create an instance.
- *
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly
- * to initialize this instance.
- *
- * @see Construct()
- */
- WifiDirectGroupClient(void);
+ //
+ // This default constructor is intentionally declared as private so that only the platform can create an instance.
+ //
+ WifiDirectGroupClient(void);
- /**
- * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] value An instance of %WifiDirectGroupClient
- */
- WifiDirectGroupClient(const WifiDirectGroupClient& value);
+ //
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectGroupClient(const WifiDirectGroupClient& value);
- /**
- * Initializes this instance of %WifiDirectGroupClient with the specified parameter.
- *
- * @return An error code
- *
- * @param[in] wifiDirectGroupClientImpl A reference to the _WifiDirectGroupClientImpl instance
- *
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- */
- result Construct(_WifiDirectGroupClientImpl& wifiDirectGroupClientImpl);
+ //
+ // Initializes this instance of %WifiDirectGroupClient with the specified parameter. @n
+ // This method is intentionally declared as private so that only the platform can initialize the instance.
+ //
+ result Construct(_WifiDirectGroupClientImpl& wifiDirectGroupClientImpl);
- /**
- * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- * copying of objects.
- *
- * @param[in] rhs An instance of %WifiDirectGroupClient
- */
- WifiDirectGroupClient& operator=(const WifiDirectGroupClient& rhs);
+ //
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectGroupClient& operator=(const WifiDirectGroupClient& rhs);
private:
- static const int DEFAULT_PORT = 3895;
+ static const int DEFAULT_PORT = 3895;
- _WifiDirectGroupClientImpl* __pWifiDirectGroupClientImpl;
+ _WifiDirectGroupClientImpl* __pWifiDirectGroupClientImpl;
- friend class _WifiDirectGroupClientImpl;
+ friend class _WifiDirectGroupClientImpl;
}; // WifiDirectGroupClient
} } } // Tizen::Net::Wifi
: public Tizen::Base::Object
{
public:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- */
- WifiDirectGroupInfo(void);
-
- /**
- * Copying of objects using this copy constructor is allowed.
- *
- * @since 2.0
- *
- * @param[in] value An instance of %WifiDirectGroupInfo
- */
- WifiDirectGroupInfo(const WifiDirectGroupInfo& value);
-
- /**
- * This is the destructor for this class.
- *
- * @since 2.0
- */
- virtual ~WifiDirectGroupInfo(void);
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ */
+ WifiDirectGroupInfo(void);
-public:
- /**
- * @if OSPDEPREC
- * Gets the autonomous group owner mode.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because this class has been modified and is now composed of information exclusively required to configure a group. @n
- * So, a new API has been added. Instead of using this API, use WifiDirectDevice::CreateAutonomousGroup() API.
-
- *
- * @since 2.0
- *
- * @return @c true if the autonomous group owner mode is activated, @n
- * else @c false
- * @endif
- */
- bool GetAutonomousGroupOwnerMode(void) const;
-
- /**
- * Gets the intent of a group owner. @n It is used during the negotiation phase.
- *
- * @since 2.0
- *
- * @return An intent value
- */
- int GetGroupOwnerIntent(void) const;
-
- /**
- * Gets the maximum number of clients to be associated.
- *
- * @since 2.0
- *
- * @return The maximum number of clients to be associated
- */
- int GetMaxNumberOfClients(void) const;
-
- /**
- * @if OSPDEPREC
- * @{
- * Gets the SSID.
- *
- * @if OSPCOMPAT
- * @brief <i> [Deprecated] [Compatibility] </i>
- * @endif
- * @deprecated This method is deprecated because this class has been modified and is now composed of information that is exclusively required to configure a group. @n
- * So, new APIs have been added. Instead of using the %GetSsid() method, use the WifiDirectDevice::GetGroupOwnerInfoN() or WifiDirectDevice::GetLocalDeviceInfo() method.
- *
- * @since 2.0
- * @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see the issue description for @ref CompWifiDirectGroupInfoGetSsidPage "here".
- * @endif
- * @return The SSID
- * @}
- * @endif
- */
- Tizen::Base::String GetSsid(void) const;
-
- /**
- * @if OSPCOMPAT
- * @page CompWifiDirectGroupInfoGetSsidPage Compatibility for GetSsid().
- * @section CompWifiDirectGroupInfoGetSsidPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
- * -# The method returns the SSID which is the same as the device name.
- *
- * @section CompWifiDirectGroupInfoGetSsidPageSolutionSection Resolutions
- * This issue has been resolved in Tizen @n
- * -# The method returns the SSID which has 'Direct-xy' as its prefix. The 'xy' is two ASCII characters or digits the
- * system generates randomly.
- * @endif
- */
-
- /**
- * @if OSPDEPREC
- * Gets the BSS ID.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because this class has been modified and is now composed of information that is exclusively required to configure a group. @n
- * So, a new API has been added. Instead of using the %GetBssId() method, use the WifiDirectDevice::GetGroupOwnerInfoN() method.
- *
- * @since 2.0
- *
- * @return The BSS ID
- * @endif
- */
- Tizen::Base::String GetBssId(void) const;
-
- /**
- * @if OSPDEPREC
- * Gets the index of a currently working channel.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because this class has been modified and is now composed of information exclusively required to configure a group. @n
- * So this API has been moved to the WifiDirectDevice class.
- *
- * @since 2.0
- *
- * @return The Wi-Fi radio channel
- * @endif
- */
- WifiRadioChannel GetOperatingChannel(void) const;
-
- /**
- * @if OSPDEPREC
- * Sets the mode for an autonomous group owner.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because this class has been modified and is now composed of information exclusively required to configure a group. @n
- * So, a new API has been added. Instead of using the %SetAutonomousGroupOwnerMode() method, use the WifiDirectDevice::CreateAutonomousGroup() method.
- *
- * @since 2.0
- *
- * @param[in] mode Set to @c true if autonomous group owner mode is enabled, @n
- * else @c false
- * @endif
- */
- void SetAutonomousGroupOwnerMode(bool mode);
-
- /**
- * Sets the intent of a group owner.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] intent The intent to become a group owner
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the specified @c intent is less than @c 0, or exceeds Wifi::MAX_WIFI_DIRECT_GROUP_OWNER_INTENT.
- * @remarks A higher intent value means that the intent to become a group owner is higher.
- * If Wifi::MAX_WIFI_DIRECT_GROUP_OWNER_INTENT is selected, it means that a device insists to be a group owner only.
- * If two devices participating in a group creation select the intent value as
- * Wifi::MAX_WIFI_DIRECT_GROUP_OWNER_INTENT, the group creation fails.
- */
- result SetGroupOwnerIntent(int intent);
-
- /**
- * Sets the maximum number of clients to be associated.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] numberOfClient The maximum number of clients to associate
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the specified @c numberOfClient is less than @c 0 or exceeds
- * Wifi::MAX_WIFI_DIRECT_CONNECTED_CLIENTS.
- */
- result SetMaxNumberOfClients(int numberOfClient);
-
- /**
- * Checks whether the specified instance of %WifiDirectGroupInfo equals the current instance.
- *
- * @since 2.0
- *
- * @return @c true if the specified instance equals the current instance, @n
- * else @c false
- * @param[in] obj An instance of %WifiDirectGroupInfo
- * @remarks This method returns @c false if the specified object is not %WifiDirectGroupInfo.
- */
- virtual bool Equals(const Tizen::Base::Object& obj) const;
-
- /**
- * Gets the hash value of the current instance.
- *
- * @since 2.0
- *
- * @return The hash value of the current instance
- */
- virtual int GetHashCode(void) const;
-
- /**
- * Assigns the value of the specified instance to the current instance of %WifiDirectGroupInfo.
- *
- * @since 2.0
- *
- * @return A reference to the %WifiDirectGroupInfo instance
- * @param[in] rhs An instance of %WifiDirectGroupInfo
- */
- WifiDirectGroupInfo& operator =(const WifiDirectGroupInfo& rhs);
+ /**
+ * Copying of objects using this copy constructor is allowed.
+ *
+ * @since 2.0
+ *
+ * @param[in] value An instance of %WifiDirectGroupInfo
+ */
+ WifiDirectGroupInfo(const WifiDirectGroupInfo& value);
+
+ /**
+ * This is the destructor for this class.
+ *
+ * @since 2.0
+ */
+ virtual ~WifiDirectGroupInfo(void);
+
+ /**
+ * @if OSPDEPREC
+ * Gets the autonomous group owner mode.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because this class has been modified and is now composed of information
+ * exclusively required to configure a group. @n
+ * So, a new API has been added. Instead of using this API, use
+ * WifiDirectDevice::CreateAutonomousGroup() API.
+
+ *
+ * @since 2.0
+ *
+ * @return @c true if the autonomous group owner mode is activated, @n
+ * else @c false
+ * @endif
+ */
+ bool GetAutonomousGroupOwnerMode(void) const;
+
+ /**
+ * Gets the intent of a group owner. @n It is used during the negotiation phase.
+ *
+ * @since 2.0
+ *
+ * @return An intent value
+ */
+ int GetGroupOwnerIntent(void) const;
+
+ /**
+ * Gets the maximum number of clients to be associated.
+ *
+ * @since 2.0
+ *
+ * @return The maximum number of clients to be associated
+ */
+ int GetMaxNumberOfClients(void) const;
+
+ /**
+ * @if OSPDEPREC
+ * @{
+ * Gets the SSID.
+ *
+ * @if OSPCOMPAT
+ * @brief <i> [Deprecated] [Compatibility] </i>
+ * @endif
+ * @deprecated This method is deprecated because this class has been modified and is now composed of information
+ * that is exclusively required to configure a group. @n
+ * So, new APIs have been added. Instead of using the %GetSsid() method, use the
+ * WifiDirectDevice::GetGroupOwnerInfoN() or WifiDirectDevice::GetLocalDeviceInfo() method.
+ *
+ * @since 2.0
+ * @if OSPCOMPAT
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see the issue description for @ref CompWifiDirectGroupInfoGetSsidPage "here".
+ * @endif
+ * @return The SSID
+ * @}
+ * @endif
+ */
+ Tizen::Base::String GetSsid(void) const;
+
+ /**
+ * @if OSPCOMPAT
+ * @page CompWifiDirectGroupInfoGetSsidPage Compatibility for GetSsid().
+ * @section CompWifiDirectGroupInfoGetSsidPageIssueSection Issues
+ * Implementing this method in OSP compatible applications has the following issues: @n
+ * -# The method returns the SSID which is the same as the device name.
+ *
+ * @section CompWifiDirectGroupInfoGetSsidPageSolutionSection Resolutions
+ * This issue has been resolved in Tizen @n
+ * -# The method returns the SSID which has 'Direct-xy' as its prefix. The 'xy' is two ASCII
+ * characters or digits thesystem generates randomly.
+ * @endif
+ */
+
+ /**
+ * @if OSPDEPREC
+ * Gets the BSS ID.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because this class has been modified and is now composed of information
+ * that is exclusively required to configure a group. @n
+ * So, a new API has been added. Instead of using the %GetBssId() method, use the
+ * WifiDirectDevice::GetGroupOwnerInfoN() method.
+ *
+ * @since 2.0
+ *
+ * @return The BSS ID
+ * @endif
+ */
+ Tizen::Base::String GetBssId(void) const;
+
+ /**
+ * @if OSPDEPREC
+ * Gets the index of a currently working channel.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because this class has been modified and is now composed of information
+ * exclusively required to configure a group. @n
+ * So this API has been moved to the WifiDirectDevice class.
+ *
+ * @since 2.0
+ *
+ * @return The Wi-Fi radio channel
+ * @endif
+ */
+ WifiRadioChannel GetOperatingChannel(void) const;
+
+ /**
+ * @if OSPDEPREC
+ * Sets the mode for an autonomous group owner.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because this class has been modified and is now composed of information
+ * exclusively required to configure a group. @n
+ * So, a new API has been added. Instead of using the %SetAutonomousGroupOwnerMode() method, use the
+ * WifiDirectDevice::CreateAutonomousGroup() method.
+ *
+ * @since 2.0
+ *
+ * @param[in] mode Set to @c true if autonomous group owner mode is enabled, @n
+ * else @c false
+ * @endif
+ */
+ void SetAutonomousGroupOwnerMode(bool mode);
+
+ /**
+ * Sets the intent of a group owner.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] intent The intent to become a group owner
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either the specified @c intent is less than @c 0, or exceeds
+ * Wifi::MAX_WIFI_DIRECT_GROUP_OWNER_INTENT.
+ * @remarks
+ * - A higher intent value means that the intent to become a group owner is higher.
+ * - If Wifi::MAX_WIFI_DIRECT_GROUP_OWNER_INTENT is selected, it means that a device insists to be a
+ * group owner only.
+ * - If two devices participating in a group creation select the intent value as
+ * Wifi::MAX_WIFI_DIRECT_GROUP_OWNER_INTENT, the group creation fails.
+ */
+ result SetGroupOwnerIntent(int intent);
+
+ /**
+ * Sets the maximum number of clients to be associated.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] numberOfClient The maximum number of clients to associate
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either the specified @c numberOfClient is less than @c 0 or exceeds
+ * Wifi::MAX_WIFI_DIRECT_CONNECTED_CLIENTS.
+ */
+ result SetMaxNumberOfClients(int numberOfClient);
+
+ /**
+ * Checks whether the specified instance of %WifiDirectGroupInfo equals the current instance.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the specified instance equals the current instance, @n
+ * else @c false
+ * @param[in] obj An instance of %WifiDirectGroupInfo
+ * @remarks This method returns @c false if the specified object is not %WifiDirectGroupInfo.
+ */
+ virtual bool Equals(const Tizen::Base::Object& obj) const;
+
+ /**
+ * Gets the hash value of the current instance.
+ *
+ * @since 2.0
+ *
+ * @return The hash value of the current instance
+ */
+ virtual int GetHashCode(void) const;
+
+ /**
+ * Assigns the value of the specified instance to the current instance of %WifiDirectGroupInfo.
+ *
+ * @since 2.0
+ *
+ * @return A reference to the %WifiDirectGroupInfo instance
+ * @param[in] rhs An instance of %WifiDirectGroupInfo
+ */
+ WifiDirectGroupInfo& operator =(const WifiDirectGroupInfo& rhs);
private:
- _WifiDirectGroupInfoImpl* __pWifiDirectGroupInfoImpl;
+ _WifiDirectGroupInfoImpl* __pWifiDirectGroupInfoImpl;
- friend class _WifiDirectGroupInfoImpl;
+ friend class _WifiDirectGroupInfoImpl;
}; // WifiDirectGroupInfo
} } } // Tizen::Net::Wifi
class WifiDirectGroupMemberImpl;
/**
* @if OSPDEPREC
- * @class WifiDirectGroupMember
- * @brief <i> [Deprecated] </i> This class provides methods for the Wi-Fi Direct group member.
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs.
+ * @class WifiDirectGroupMember
+ * @brief <i> [Deprecated] </i> This class provides methods for the Wi-Fi Direct group member.
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with
+ * ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to
+ * use these APIs.
*
- * @since 2.0
+ * @since 2.0
*
* The %WifiDirectGroupMember class provides methods for the Wi-Fi Direct group member.
* @endif
: public Tizen::Base::Object
{
public:
- /**
- * @if OSPDEPREC
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs.
- * @since 2.0
- * @endif
- */
- virtual ~WifiDirectGroupMember(void){}
+ /**
+ * @if OSPDEPREC
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs.
+ * @since 2.0
+ * @endif
+ */
+ virtual ~WifiDirectGroupMember(void){}
- /**
- * @if OSPDEPREC
- * Gets the type of the Wi-Fi Direct group member.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs.
- *
- * @since 2.0
- *
- * @return The type of the Wi-Fi Direct group member
- * @endif
- */
- WifiDirectGroupMemberType GetGroupMemberType(void) const;
+ /**
+ * @if OSPDEPREC
+ * Gets the type of the Wi-Fi Direct group member.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs
+ * with ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary
+ * to use these APIs.
+ *
+ * @since 2.0
+ *
+ * @return The type of the Wi-Fi Direct group member
+ * @endif
+ */
+ WifiDirectGroupMemberType GetGroupMemberType(void) const;
protected:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- */
- WifiDirectGroupMember(void);
- /**
- * This is the copy constructor for the %WifiDirectGroupMember class. @n
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ */
+ WifiDirectGroupMember(void);
+
+ /**
+ * This is the copy constructor for the %WifiDirectGroupMember class. @n
* Do @b not use directly.
*
- * @since 2.0
- *
- * @param[in] value An instance of %WifiDirectGroupMember
- */
- WifiDirectGroupMember(const WifiDirectGroupMember& value);
+ * @since 2.0
+ *
+ * @param[in] value An instance of %WifiDirectGroupMember
+ */
+ WifiDirectGroupMember(const WifiDirectGroupMember& value);
- /**
- * Assigns the value of the specified instance to the current instance of %WifiDirectGroupMember. @n
+ /**
+ * Assigns the value of the specified instance to the current instance of %WifiDirectGroupMember. @n
* Do @b not use directly.
*
- * @since 2.0
- *
- * @param[in] rhs An instance of %WifiDirectGroupMember
- */
- WifiDirectGroupMember& operator =(const WifiDirectGroupMember& rhs);
+ * @since 2.0
+ *
+ * @param[in] rhs An instance of %WifiDirectGroupMember
+ */
+ WifiDirectGroupMember& operator =(const WifiDirectGroupMember& rhs);
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void WifiDirectGroupMember_Reserved1(void){ }
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void WifiDirectGroupMember_Reserved1(void){ }
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void WifiDirectGroupMember_Reserved2(void){ }
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void WifiDirectGroupMember_Reserved2(void){ }
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void WifiDirectGroupMember_Reserved3(void){ }
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void WifiDirectGroupMember_Reserved3(void){ }
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void WifiDirectGroupMember_Reserved4(void){ }
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void WifiDirectGroupMember_Reserved4(void){ }
- //
- // This method is for internal use only. Using this method can cause behavioral, security-related,
- // and consistency-related issues in the application.
- //
- //
- // This method is reserved and may change its name at any time without prior notice.
- //
- // @since 2.0
- //
- virtual void WifiDirectGroupMember_Reserved5(void){ }
+ //
+ // This method is for internal use only. Using this method can cause behavioral, security-related,
+ // and consistency-related issues in the application.
+ //
+ // This method is reserved and may change its name at any time without prior notice.
+ //
+ // @since 2.0
+ //
+ virtual void WifiDirectGroupMember_Reserved5(void){ }
protected:
- WifiDirectGroupMemberType _groupMemberType;
+ WifiDirectGroupMemberType _groupMemberType;
+ WifiDirectGroupMemberImpl* _pWifiDirectGroupMemberImpl;
- WifiDirectGroupMemberImpl* _pWifiDirectGroupMemberImpl;
- friend class WifiDirectGroupMemberImpl;
+ friend class WifiDirectGroupMemberImpl;
}; // WifiDirectGroupMember
} } } // Tizen::Net::Wifi
/**
* @if OSPDEPREC
- * @class WifiDirectGroupOwner
- * @brief <i> [Deprecated] </i> This class provides methods for the Wi-Fi Direct group owner management.
- * @deprecated This class is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs. @n
- * As the APIs have been integrated into the WifiDirectDevice class, use IWifiDirectDevice class instead.
+ * @class WifiDirectGroupOwner
+ * @brief <i> [Deprecated] </i> This class provides methods for the Wi-Fi Direct group owner management.
+ * @deprecated This class is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with
+ * ease irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to
+ * use these APIs. @n
+ * As the APIs have been integrated into the WifiDirectDevice class, use IWifiDirectDevice class instead.
*
- * @since 2.0
+ * @since 2.0
*
* The %WifiDirectGroupOwner class provides methods to manage the Wi-Fi Direct group.
* @endif
*/
class _OSP_EXPORT_ WifiDirectGroupOwner
- : public WifiDirectGroupMember
+ : public WifiDirectGroupMember
{
public:
- /**
- * @if OSPDEPREC
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
- *
- * @since 2.0
- * @endif
- */
- virtual ~WifiDirectGroupOwner(void);
-
- /**
- * @if OSPDEPREC
- * Destroys a Wi-Fi Direct group.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
-* Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- * As the APIs have been integrated into the WifiDirectDevice class, use the WifiDirectDevice::LeaveGroup() method instead.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, when the member type of a device is not a Wi-Fi Direct group owner.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiDirectGroupOwnerListener::OnWifiDirectGroupDestroyed()
- * @endif
- */
- result DestroyGroup(void);
-
- /**
- * @if OSPDEPREC
- * Disconnects a specified Wi-Fi Direct group client.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- * As the APIs have been integrated into the WifiDirectDevice class, use the WifiDirectDevice::Disconnect() method instead.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
- *
- * @return An error code
- * @param[in] wifiDirectRemoteDeviceInfo The device information of a group client to disconnect
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
- * For example, when the member type of a device is not a Wi-Fi Direct group owner.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiDirectGroupOwnerListener::OnWifiDirectClientDisassociated()
- * @endif
- */
- result Disconnect(const WifiDirectDeviceInfo& wifiDirectRemoteDeviceInfo);
-
- /**
- * @if OSPDEPREC
- * Gets the list of information of all the members of the Wi-Fi Direct group.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role. @n
- * Instead of the GetAllGroupMemberInfoListN() method, use WifiDirectDevice::GetGroupOwnerInfoN() for group owner information and WifiDirectDevice::GetGroupClientInfoListN() for group clients information.
- *
- * @since 2.0
- *
- * @return The list of WifiDirectDeviceInfo
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ /**
+ * @if OSPDEPREC
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role.
+ *
+ * @since 2.0
+ * @endif
+ */
+ virtual ~WifiDirectGroupOwner(void);
+
+ /**
+ * @if OSPDEPREC
+ * Destroys a Wi-Fi Direct group.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * As the APIs have been integrated into the WifiDirectDevice class, use the
+ * WifiDirectDevice::LeaveGroup() method instead.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
* For example, when the member type of a device is not a Wi-Fi Direct group owner.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @endif
- */
- Tizen::Base::Collection::IList* GetAllGroupMemberInfoListN(void) const;
-
- /**
- * @if OSPDEPREC
- * Starts the group member information service.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection and %http://tizen.org/privilege/socket @n
- * All the above privileges are required
- *
- * @return An error code
- * @param[in] portNumber A port number to start group member information service
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_OUT_OF_RANGE The specified port number is less than 1024 or greater than 65535.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * For example, member type of @c wifiDirectDevice is not the group owner or client.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiDirectGroupOwnerListener::OnWifiDirectGroupMemberInfoServiceStarted()
- * @endif
- */
- result StartGroupMemberInfoService(int portNumber = DEFAULT_PORT);
-
- /**
- * @if OSPDEPREC
- * Stops the group member information service.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group owner, group client, and so on) and so it was necessary to use these APIs. @n
- * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection and %http://tizen.org/privilege/socket @n
- * All the above privileges are required
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_IN_PROGRESS A previous request is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiDirectGroupOwnerListener::OnWifiDirectGroupMemberInfoServiceStopped()
- * @endif
- */
- result StopGroupMemberInfoService(void);
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiDirectGroupOwnerListener::OnWifiDirectGroupDestroyed()
+ * @endif
+ */
+ result DestroyGroup(void);
+
+ /**
+ * @if OSPDEPREC
+ * Disconnects a specified Wi-Fi Direct group client.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * As the APIs have been integrated into the WifiDirectDevice class, use the
+ * WifiDirectDevice::Disconnect() method instead.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.admin
+ *
+ * @return An error code
+ * @param[in] wifiDirectRemoteDeviceInfo The device information of a group client to disconnect
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, when the member type of a device is not a Wi-Fi Direct group owner.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiDirectGroupOwnerListener::OnWifiDirectClientDisassociated()
+ * @endif
+ */
+ result Disconnect(const WifiDirectDeviceInfo& wifiDirectRemoteDeviceInfo);
+
+ /**
+ * @if OSPDEPREC
+ * Gets the list of information of all the members of the Wi-Fi Direct group.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role. @n
+ * Instead of the GetAllGroupMemberInfoListN() method, use WifiDirectDevice::GetGroupOwnerInfoN() for
+ * group owner information and WifiDirectDevice::GetGroupClientInfoListN() for group clients information.
+ *
+ * @since 2.0
+ *
+ * @return The list of WifiDirectDeviceInfo
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this operation. @n
+ * For example, when the member type of a device is not a Wi-Fi Direct group owner.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @endif
+ */
+ Tizen::Base::Collection::IList* GetAllGroupMemberInfoListN(void) const;
+
+ /**
+ * @if OSPDEPREC
+ * Starts the group member information service.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the
+ * role.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection
+ * and %http://tizen.org/privilege/socket @n
+ * All the above privileges are required.
+ *
+ * @return An error code
+ * @param[in] portNumber A port number to start group member information service
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_OUT_OF_RANGE The specified port number is less than 1024 or greater than 65535.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
+ * For example, member type of @c wifiDirectDevice is not the group owner or client.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiDirectGroupOwnerListener::OnWifiDirectGroupMemberInfoServiceStarted()
+ * @endif
+ */
+ result StartGroupMemberInfoService(int portNumber = DEFAULT_PORT);
+
+ /**
+ * @if OSPDEPREC
+ * Stops the group member information service.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated The %WifiDirectGroupOwner class is deprecated, therefore, this method is also deprecated. @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role (for example, group
+ * owner, group client, and so on) and so it was necessary to use these APIs. @n
+ * Now the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.wifidirect.read, %http://tizen.org/privilege/network.connection
+ * and %http://tizen.org/privilege/socket @n
+ * All the above privileges are required.
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_IN_PROGRESS A previous request is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiDirectGroupOwnerListener::OnWifiDirectGroupMemberInfoServiceStopped()
+ * @endif
+ */
+ result StopGroupMemberInfoService(void);
private:
- /**
- * This default constructor is intentionally declared as private so that only the platform can create an instance.
- *
- * @remarks After creating an instance of this class, the Construct() method must be explicitly called to
- * initialize this instance.
- * @see Construct()
- */
- WifiDirectGroupOwner(void);
-
- /**
- * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] value An instance of %WifiDirectGroupOwner
- */
- WifiDirectGroupOwner(const WifiDirectGroupOwner& value);
-
- /**
- * Initializes this instance of WifiDirectGroupOwner with the specified listener.
- *
- * @return An error code
- *
- * @param[in] wifiDirectDeviceImpl A reference to the __WifiDirectDeviceImpl instance
- *
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- */
- result Construct(_WifiDirectGroupOwnerImpl& wifiDirectGroupOwnerImpl);
-
- /**
- * The implementation of this copy assignment operator is intentionally blank and
- * declared as private to prohibit copying of objects.
- *
- * @param[in] rhs An instance of %WifiDirectGroupOwner
- */
- WifiDirectGroupOwner& operator =(const WifiDirectGroupOwner& rhs);
+ //
+ // This default constructor is intentionally declared as private so that only the platform can create an instance.
+ //
+ WifiDirectGroupOwner(void);
+
+ //
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectGroupOwner(const WifiDirectGroupOwner& value);
+
+ //
+ // Initializes this instance of WifiDirectGroupOwner with the specified listener. @n
+ // This method is intentionally declared as private so that only the platform can initialize the instance.
+ //
+ result Construct(_WifiDirectGroupOwnerImpl& wifiDirectGroupOwnerImpl);
+
+ //
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
+ //
+ WifiDirectGroupOwner& operator =(const WifiDirectGroupOwner& rhs);
private:
- static const int DEFAULT_PORT = 3895;
+ static const int DEFAULT_PORT = 3895;
- _WifiDirectGroupOwnerImpl* __pWifiDirectGroupOwnerImpl;
+ _WifiDirectGroupOwnerImpl* __pWifiDirectGroupOwnerImpl;
- friend class _WifiDirectGroupOwnerImpl;
+ friend class _WifiDirectGroupOwnerImpl;
}; // WifiDirectGroupOwner
} } } // Tizen::Net::Wifi
*
* @since 2.0
*
- * The %WifiManager class provides methods for creating a %WifiManager instance, and managing the local Wi-Fi devices. It also allows the
- * listener to get the events from the local Wi-Fi devices.
+ * The %WifiManager class provides methods for creating a %WifiManager instance, and managing the local Wi-Fi devices.
+ * It also allows the listener to get the events from the local Wi-Fi devices.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
*
* The following example demonstrates how to use the %WifiManager class.
*
: public Tizen::Base::Object
{
public:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- *
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize the instance.
- * @see Construct()
- */
- WifiManager(void);
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ *
+ * @remarks After creating an instance of this class, the Construct() method must be called explicitly to
+ * initialize the instance.
+ * @see Construct()
+ */
+ WifiManager(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
- virtual ~WifiManager(void);
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
+ virtual ~WifiManager(void);
- /**
- * Initializes this instance of %WifiManager with the specified listener.
- *
- * @since 2.0
- *
- * @feature %http://tizen.org/feature/network.wifi
- *
- * @return An error code
- * @param[in] listener A reference to the listener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION The device does not support the Wi-Fi feature.
- * For more information, see <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>Application Filtering</a>.
- * @remarks
- * - The @c listener instance must not be deleted before destructing this instance.
- * - Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
- */
- result Construct(IWifiManagerEventListener& listener);
+ /**
+ * Initializes this instance of %WifiManager with the specified listener.
+ *
+ * @since 2.0
+ *
+ * @feature %http://tizen.org/feature/network.wifi
+ *
+ * @return An error code
+ * @param[in] listener A reference to the listener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_UNSUPPORTED_OPERATION The device does not support the Wi-Fi feature.For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
+ * @remarks
+ * - The @c listener instance must not be deleted before destructing this instance.
+ * - Before calling this method, check whether the feature is supported by
+ * %Tizen::System::SystemInfo::GetValue() methods.
+ */
+ result Construct(IWifiManagerEventListener& listener);
- /**
- * Activates the local Wi-Fi device.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.admin
- *
- * @return An error code
- * @exception E_SUCCESS The activation is successful.
- * @exception E_FAILURE The method has failed to activate.
- * @exception E_IN_PROGRESS The activate process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * For example, the Wi-Fi is already activated.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiManagerEventListener::OnWifiActivated()
- */
- result Activate(void) const;
+ /**
+ * Activates the local Wi-Fi device.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The activation is successful.
+ * @exception E_FAILURE The method has failed to activate.
+ * @exception E_IN_PROGRESS The activate process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
+ * For example, the Wi-Fi is already activated.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiManagerEventListener::OnWifiActivated()
+ */
+ result Activate(void) const;
- /**
- * Deactivates the local Wi-Fi device.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.admin
- *
- * @return An error code
- * @exception E_SUCCESS The deactivation is successful.
- * @exception E_FAILURE The method has failed to deactivate.
- * @exception E_IN_PROGRESS The deactivate process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * For example, the Wi-Fi is already deactivated.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiManagerEventListener::OnWifiDeactivated()
- */
- result Deactivate(void) const;
+ /**
+ * Deactivates the local Wi-Fi device.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The deactivation is successful.
+ * @exception E_FAILURE The method has failed to deactivate.
+ * @exception E_IN_PROGRESS The deactivate process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
+ * For example, the Wi-Fi is already deactivated.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiManagerEventListener::OnWifiDeactivated()
+ */
+ result Deactivate(void) const;
- /**
- * Gets the current power status of the local Wi-Fi device.
- *
- * @since 2.0
- *
- * @return The current power status of the local Wi-Fi device
- */
- WifiPowerStatus GetPowerStatus(void) const;
+ /**
+ * Gets the current power status of the local Wi-Fi device.
+ *
+ * @since 2.0
+ *
+ * @return The current power status of the local Wi-Fi device
+ */
+ WifiPowerStatus GetPowerStatus(void) const;
- /**
- * Gets the MAC address of the Wi-Fi device.
- *
- * @since 2.0
- *
- * @return The MAC address in the form '00-00-00-00-00-00'
- * @remarks This MAC address is different from the MAC address provided by the WifiDirectDevice class.
- */
- Tizen::Base::String GetMacAddress(void) const;
+ /**
+ * Gets the MAC address of the Wi-Fi device.
+ *
+ * @since 2.0
+ *
+ * @return The MAC address in the form '00-00-00-00-00-00'
+ * @remarks This MAC address is different from the MAC address provided by the WifiDirectDevice class.
+ */
+ Tizen::Base::String GetMacAddress(void) const;
- /**
- * Checks whether the local device is activated.
- *
- * @since 2.0
- *
- * @return @c true if the local device is activated, @n
- * else @c false
- */
- bool IsActivated(void) const;
+ /**
+ * Checks whether the local device is activated.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the local device is activated, @n
+ * else @c false
+ */
+ bool IsActivated(void) const;
- /**
- * Checks whether the local device is connected with a remote Access Point(AP).
- *
- * @since 2.0
- *
- * @return @c true if the local device is connected with a remote Access Point(AP), @n
- * else @c false
- */
- bool IsConnected(void) const;
+ /**
+ * Checks whether the local device is connected with a remote Access Point(AP).
+ *
+ * @since 2.0
+ *
+ * @return @c true if the local device is connected with a remote Access Point(AP), @n
+ * else @c false
+ */
+ bool IsConnected(void) const;
- /**
- * Scans for a nearby BSS with both the infrastructure and independent modes.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.read
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_FAILURE The method has failed.
- * @exception E_INVALID_STATE This instance is in an invalid state.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Only active scan (probing for Access Points(APs) and ad hoc stations in the range) is supported.
- * This operation does not work while the Wi-Fi Direct scanning or connection is in progress.
- * @see IWifiManagerEventListener::OnWifiScanCompletedN()
- */
- result Scan(void);
+ /**
+ * Scans for a nearby BSS with both the infrastructure and independent modes.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.read
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FAILURE The method has failed.
+ * @exception E_INVALID_STATE This instance is in an invalid state.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - Only active scan (probing for Access Points(APs) and ad hoc stations in the range) is supported.
+ * - This operation does not work while the Wi-Fi Direct scanning or connection is in progress.
+ * @see IWifiManagerEventListener::OnWifiScanCompletedN()
+ */
+ result Scan(void);
- /**
- * Connects to a specific access point that is a BSS with an infrastructure mode.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.admin
- *
- * @return An error code
- * @param[in] targetApInfo A BSS information representing the target access point
- * @exception E_SUCCESS The method is successful.
- * @exception E_FAILURE The method has failed.
- * @exception E_IN_PROGRESS The previous request is in progress.
- * @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * For example, the BSS type is an independent mode.
- * @exception E_INVALID_STATE This instance is in an invalid state.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks If a connection to another access point is already established, it will be disconnected and the new connection
- * of this method will be established.
- * @see IWifiManagerEventListener::OnWifiConnected()
- */
- result Connect(const WifiBssInfo& targetApInfo);
+ /**
+ * Connects to a specific access point that is a BSS with an infrastructure mode.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.admin
+ *
+ * @return An error code
+ * @param[in] targetApInfo A BSS information representing the target access point
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FAILURE The method has failed.
+ * @exception E_IN_PROGRESS The previous request is in progress.
+ * @exception E_INVALID_ARG The specified input parameter is invalid. @n
+ * For example, the BSS type is an independent mode.
+ * @exception E_INVALID_STATE This instance is in an invalid state.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks If a connection to another access point is already established, it will be disconnected and the new
+ * connection of this method will be established.
+ * @see IWifiManagerEventListener::OnWifiConnected()
+ */
+ result Connect(const WifiBssInfo& targetApInfo);
- /**
- * Sets the behavior mode of the Wi-Fi background system about connection and background scanning.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] mode A Wi-Fi background system mode
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OPERATION_FAILED The operation has failed.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- */
- result SetWifiSystemScanMode(WifiSystemScanMode mode);
+ /**
+ * Sets the behavior mode of the Wi-Fi background system about connection and background scanning.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] mode A Wi-Fi background system mode
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_OPERATION_FAILED The operation has failed.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ */
+ result SetWifiSystemScanMode(WifiSystemScanMode mode);
- /**
- * Adds the specified @c listener for receiving the notification when the state of current Wi-Fi connection is changed
- * or the result of Wi-Fi background scanning is updated.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] listener The listener to add
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener is already added.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- */
- result AddSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
+ /**
+ * Adds the specified @c listener for receiving the notification when the state of current Wi-Fi connection is changed
+ * or the result of Wi-Fi background scanning is updated.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] listener The listener to add
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ */
+ result AddSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
- /**
- * Removes the specified IWifiSystemMonitoringEventListener instance for receiving the notification. @n The removed listener
- * cannot listen to the events that are fired.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] listener The listener to remove
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listener is not found.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- */
- result RemoveSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
+ /**
+ * Removes the specified IWifiSystemMonitoringEventListener instance for receiving the notification. @n The removed listener
+ * cannot listen to the events that are fired.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] listener The listener to remove
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The listener is not found.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ */
+ result RemoveSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
- /**
- * Gets the state of current Wi-Fi connection.
- *
- * @since 2.0
- *
- * @return The state of the current Wi-Fi connection
- */
- WifiConnectionState GetConnectionState(void) const;
+ /**
+ * Gets the state of current Wi-Fi connection.
+ *
+ * @since 2.0
+ *
+ * @return The state of the current Wi-Fi connection
+ */
+ WifiConnectionState GetConnectionState(void) const;
- /**
- * Gets the information of current Wi-Fi connection target which the local device is connecting or connected with.
- *
- * @since 2.0
- *
- * @return A pointer to the WifiBssInfo instance representing the information of current Wi-Fi connection target, @n
- * else @c null if GetConnectionState() is ::WIFI_CONN_STATE_NOT_CONNECTED
- */
- WifiBssInfo* GetConnectionTargetInfoN(void) const;
+ /**
+ * Gets the information of current Wi-Fi connection target which the local device is connecting or connected with.
+ *
+ * @since 2.0
+ *
+ * @return A pointer to the WifiBssInfo instance representing the information of current Wi-Fi connection target, @n
+ * else @c null if GetConnectionState() is ::WIFI_CONN_STATE_NOT_CONNECTED
+ */
+ WifiBssInfo* GetConnectionTargetInfoN(void) const;
- /**
- * Updates the Wi-Fi BSS information which is saved in the underlying Wi-Fi system.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] bssInfo A BSS information representing the access point
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OBJ_NOT_FOUND The specified input parameter is not found.
- * @exception E_OPERATION_FAILED The operation has failed.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- *
- * @remarks The updated information is deleted when Wi-Fi is turned off if the BSS has never been connected before.
- */
- result UpdateBssInfo(const WifiBssInfo& bssInfo);
+ /**
+ * Updates the Wi-Fi BSS information which is saved in the underlying Wi-Fi system.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] bssInfo A BSS information representing the access point
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_OBJ_NOT_FOUND The specified input parameter is not found.
+ * @exception E_OPERATION_FAILED The operation has failed.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ *
+ * @remarks The updated information is deleted when Wi-Fi is turned off if the BSS has never been connected before.
+ */
+ result UpdateBssInfo(const WifiBssInfo& bssInfo);
- /**
- * Gets a list of the latest search results which the underlying Wi-Fi system scan periodically on background.
- *
- * @since 2.0
- *
- * @return A Tizen::Base::Collection::IList containing WifiBssInfo of existing Wi-Fi connections if successful, @n
- * else @c null
- */
- Tizen::Base::Collection::IList* GetSystemScanResultN(void) const;
+ /**
+ * Gets a list of the latest search results which the underlying Wi-Fi system scan periodically on background.
+ *
+ * @since 2.0
+ *
+ * @return A Tizen::Base::Collection::IList containing WifiBssInfo of existing Wi-Fi connections if successful, @n
+ * else @c null
+ */
+ Tizen::Base::Collection::IList* GetSystemScanResultN(void) const;
private:
- /**
- * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] value An instance of %WifiManager
- */
- WifiManager(const WifiManager& value);
+ //
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
+ //
+ WifiManager(const WifiManager& value);
- /**
- * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] rhs An instance of %WifiManager
- */
- WifiManager& operator=(const WifiManager& rhs);
+ //
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
+ //
+ WifiManager& operator=(const WifiManager& rhs);
private:
- _WifiManagerImpl* __pWifiManagerImpl;
+ _WifiManagerImpl* __pWifiManagerImpl;
- friend class _WifiManagerImpl;
+ friend class _WifiManagerImpl;
}; // WifiManager
} } } // Tizen::Net::Wifi
*
* @since 2.0
*
- * The %WifiNetAccountInfo class provides the functionality to control the WLAN network accounts and the basic network accounts. This class inherits the
- * NetAccountInfo class.
+ * The %WifiNetAccountInfo class provides the functionality to control the WLAN network accounts and the basic network accounts.
+ * This class inherits the NetAccountInfo class.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
*/
class _OSP_EXPORT_ WifiNetAccountInfo
: public Tizen::Net::NetAccountInfo
{
public:
- /**
- * This is the destructor for this class.
- *
- *
- * @since 2.0
- */
- virtual ~WifiNetAccountInfo(void);
-
- /**
- * Gets the BSSID of this account.
- *
- * @since 2.0
- *
- * @return The BSS ID in the form '00-00-00-00-00-00'
- * @remarks This operation is not yet supported.
- */
- Tizen::Base::String GetBssId(void) const;
-
- /**
- * Gets the SSID of this account.
- *
- * @since 2.0
- *
- * @return The SSID of this account
- */
- Tizen::Base::String GetSsid(void) const;
-
- /**
- * Gets the type of BSS of this account.
- *
- * @since 2.0
- *
- * @return The type of BSS of this account
- */
- WifiBssType GetBssType(void) const;
-
- /**
- * Gets the security information of this account.
- *
- * @since 2.0
- *
- * @return The authentication and encryption type of this account
- */
- const WifiSecurityInfo* GetSecurityInfo(void) const;
-
- /**
- * Gets the radio channel of this account. @n
- * If this value is not set, the default value is WIFI_RADIO_CHANNEL_UNKNOWN.
- *
- * @since 2.0
- *
- * @return The radio channel of this account
- * @remarks This operation is not yet supported.
- */
- WifiRadioChannel GetRadioChannel(void) const;
-
- /**
- * Checks whether the specified instance of %WifiNetAccountInfo equals the current instance.
- *
- * @since 2.0
- *
- * @return @c true if the specified instance equals the current instance, @n
- * else @c false
- * @param[in] obj An instance of %WifiNetAccountInfo
- * @remarks This method returns @c false if the specified object is not %WifiNetAccountInfo.
- */
- virtual bool Equals(const Tizen::Base::Object& obj) const;
-
- /**
- * Gets the hash value of the current instance.
- *
- * @since 2.0
- *
- * @return The hash value of the current instance
- */
- virtual int GetHashCode(void) const;
+ /**
+ * This is the destructor for this class.
+ *
+ *
+ * @since 2.0
+ */
+ virtual ~WifiNetAccountInfo(void);
+
+ /**
+ * Gets the BSSID of this account.
+ *
+ * @since 2.0
+ *
+ * @return The BSS ID in the form '00-00-00-00-00-00'
+ * @remarks This operation is not yet supported.
+ */
+ Tizen::Base::String GetBssId(void) const;
+
+ /**
+ * Gets the SSID of this account.
+ *
+ * @since 2.0
+ *
+ * @return The SSID of this account
+ */
+ Tizen::Base::String GetSsid(void) const;
+
+ /**
+ * Gets the type of BSS of this account.
+ *
+ * @since 2.0
+ *
+ * @return The type of BSS of this account
+ */
+ WifiBssType GetBssType(void) const;
+
+ /**
+ * Gets the security information of this account.
+ *
+ * @since 2.0
+ *
+ * @return The authentication and encryption type of this account
+ */
+ const WifiSecurityInfo* GetSecurityInfo(void) const;
+
+ /**
+ * Gets the radio channel of this account. @n
+ * If this value is not set, the default value is WIFI_RADIO_CHANNEL_UNKNOWN.
+ *
+ * @since 2.0
+ *
+ * @return The radio channel of this account
+ * @remarks This operation is not yet supported.
+ */
+ WifiRadioChannel GetRadioChannel(void) const;
+
+ /**
+ * Checks whether the specified instance of %WifiNetAccountInfo equals the current instance.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the specified instance equals the current instance, @n
+ * else @c false
+ * @param[in] obj An instance of %WifiNetAccountInfo
+ * @remarks This method returns @c false if the specified object is not %WifiNetAccountInfo.
+ */
+ virtual bool Equals(const Tizen::Base::Object& obj) const;
+
+ /**
+ * Gets the hash value of the current instance.
+ *
+ * @since 2.0
+ *
+ * @return The hash value of the current instance
+ */
+ virtual int GetHashCode(void) const;
private:
- /**
- * This default constructor is intentionally declared as private so that only the platform can create an instance.
- *
- */
- WifiNetAccountInfo(void);
-
- /**
- * This copy constructor is intentionally declared as private to prohibit copying of objects by users.
- *
- * @param[in] value An instance of %WifiNetAccountInfo
- */
- WifiNetAccountInfo(const WifiNetAccountInfo& value);
-
- /**
- * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] rhs An instance of %WifiNetAccountInfo
- */
- WifiNetAccountInfo& operator=(const WifiNetAccountInfo& rhs);
+ //
+ // This default constructor is intentionally declared as private so that only the platform can create an instance.
+ //
+ WifiNetAccountInfo(void);
+
+ //
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
+ //
+ WifiNetAccountInfo(const WifiNetAccountInfo& value);
+
+ //
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
+ //
+ WifiNetAccountInfo& operator=(const WifiNetAccountInfo& rhs);
private:
- _WifiNetAccountInfoImpl* __pWifiNetAccountInfoImpl;
+ _WifiNetAccountInfoImpl* __pWifiNetAccountInfoImpl;
- friend class _WifiNetAccountInfoImpl;
+ friend class _WifiNetAccountInfoImpl;
}; // WifiNetAccountInfo
} } } // Tizen::Net::Wifi
*
* @since 2.0
*
- * The %WifiSecurityInfo class is used with the WifiNetAccountInfo class to set and get the security information of a Wi-Fi network.
+ * The %WifiSecurityInfo class is used with the WifiNetAccountInfo class to set and get the security information of a Wi-Fi
+ * network.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
*/
class _OSP_EXPORT_ WifiSecurityInfo
: public Tizen::Base::Object
{
public:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- */
- WifiSecurityInfo(void);
-
- /**
- * Copying of objects using this copy constructor is allowed.
- *
- * @since 2.0
- *
- * @param[in] value An instance of %WifiSecurityInfo
- */
- WifiSecurityInfo(const WifiSecurityInfo& value);
-
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
- virtual ~WifiSecurityInfo(void);
-
- /**
- * Gets the authentication type of this account.
- *
- * @since 2.0
- *
- * @return The authentication type of this account
- */
- WifiAuthenticationType GetAuthenticationType(void) const;
-
- /**
- * Gets the encryption type of this account.
- *
- * @since 2.0
- *
- * @return The encryption type
- * @remarks If the encryption type is @c WIFI_ENCRYPTION_TKIP_AES_MIXED, either SetNetworkKeyAes() or
- * SetNetworkKeyTkip() can be used to set the key.
- */
- WifiEncryptionType GetEncryptionType(void) const;
-
- /**
- * @if OSPDEPREC
- * Sets the Wired Equivalent Privacy (WEP) key data.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the key value does not need to set for each encryption type.
- * Instead of using this method, use SetNetworkKey().
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] keyLen A WifiWepKeyLen enumerator value
- * @param[in] keyIndex The key index of WEP key to set
- * @param[in] key The key data to set
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified @c key exceeds @c 10 bytes when the
- * value of @c keyLen is Wifi::WIFI_WEP_KEY_LEN_64BIT,
- * or the length of the specified @c key exceeds @c 26 bytes when
- * the value of @c keyLen is Wifi::WIFI_WEP_KEY_LEN_128BIT.
- * @exception E_SYSTEM A system error has occurred.
- * @endif
- */
- result SetNetworkKeyWep(WifiWepKeyLen keyLen, WifiWepKeyIndex keyIndex, const Tizen::Base::String& key);
-
- /**
- * @if OSPDEPREC
- * Sets the Advanced Encryption Standard (AES) key data.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the key value does not need to set for each encryption type.
- * Instead of using this method, use SetNetworkKey().
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] key The key data to set
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified @c key exceeds @c 64 bytes.
- * @exception E_SYSTEM A system error has occurred.
- * @endif
- */
- result SetNetworkKeyAes(const Tizen::Base::String& key);
-
- /**
- * @if OSPDEPREC
- * Sets the Temporal Key Integrity Protocol (TKIP) key data.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the key value does not need to set for each encryption type.
- * Instead of using this method, use SetNetworkKey().
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] key The key data to set
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified @c key exceeds @c 64 bytes.
- * @exception E_SYSTEM A system error has occurred.
- * @endif
- */
- result SetNetworkKeyTkip(const Tizen::Base::String& key);
-
- /**
- * Sets the Extensible Authentication Protocol (EAP) method information.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] type The EAP method type
- * @param[in] userId The user ID to set @n
- * Its length must not exceed @c 256 bytes.
- * @param[in] password The password to set @n
- * Its length must not exceed @c 256 bytes.
- * @param[in] validateServerCertificate Set to @c true to determine the validation of the server certificate, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified @c userId or @c password exceeds @c 256 bytes.
- * @exception E_UNSUPPORTED_TYPE The input @c type is not supported.
- * @exception E_SYSTEM A system error has occurred.
- */
- result SetEapMethodInfo(WifiEapType type, const Tizen::Base::String& userId, const Tizen::Base::String& password, bool validateServerCertificate = true);
-
- /**
- * Sets the network key.
- *
- * @since 2.0
- *
- * @param[in] key The network key
- */
- void SetNetworkKey(const Tizen::Base::String& key);
-
- /**
- * Sets the authentication type.
- *
- * @since 2.0
- *
- * @param[in] authType The authentication type
- */
- void SetAuthenticationType(WifiAuthenticationType authType);
-
- /**
- * Checks whether the specified instance of %WifiSecurityInfo equals the current instance.
- *
- * @since 2.0
- *
- * @return @c true if the specified instance equals the current instance, @n
- * else @c false
- * @param[in] obj An instance of %WifiSecurityInfo
- * @remarks This method returns @c false if the specified object is not %WifiSecurityInfo.
- */
- virtual bool Equals(const Tizen::Base::Object& obj) const;
-
- /**
- * Gets the hash value of the current instance.
- *
- * @since 2.0
- *
- * @return The hash value of the current instance
- */
- virtual int GetHashCode(void) const;
-
- /**
- * Assigns the value of the specified instance to the current instance of %WifiSecurityInfo.
- *
- * @since 2.0
- *
- * @return The reference of this instance
- * @param[in] rhs An instance of %WifiSecurityInfo
- */
- WifiSecurityInfo& operator=(const WifiSecurityInfo& rhs);
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ */
+ WifiSecurityInfo(void);
+
+ /**
+ * Copying of objects using this copy constructor is allowed.
+ *
+ * @since 2.0
+ *
+ * @param[in] value An instance of %WifiSecurityInfo
+ */
+ WifiSecurityInfo(const WifiSecurityInfo& value);
+
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
+ virtual ~WifiSecurityInfo(void);
+
+ /**
+ * Gets the authentication type of this account.
+ *
+ * @since 2.0
+ *
+ * @return The authentication type of this account
+ */
+ WifiAuthenticationType GetAuthenticationType(void) const;
+
+ /**
+ * Gets the encryption type of this account.
+ *
+ * @since 2.0
+ *
+ * @return The encryption type
+ * @remarks If the encryption type is @c WIFI_ENCRYPTION_TKIP_AES_MIXED, either SetNetworkKeyAes() or
+ * SetNetworkKeyTkip() can be used to set the key.
+ */
+ WifiEncryptionType GetEncryptionType(void) const;
+
+ /**
+ * @if OSPDEPREC
+ * Sets the Wired Equivalent Privacy (WEP) key data.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the key value does not need to set for each encryption type.
+ * Instead of using this method, use SetNetworkKey().
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] keyLen A WifiWepKeyLen enumerator value
+ * @param[in] keyIndex The key index of WEP key to set
+ * @param[in] key The key data to set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The length of the specified @c key exceeds @c 10 bytes when the value of @c keyLen
+ * is Wifi::WIFI_WEP_KEY_LEN_64BIT, or the length of the specified @c key exceeds
+ * @c 26 bytes when the value of @c keyLen is Wifi::WIFI_WEP_KEY_LEN_128BIT.
+ * @exception E_SYSTEM A system error has occurred.
+ * @endif
+ */
+ result SetNetworkKeyWep(WifiWepKeyLen keyLen, WifiWepKeyIndex keyIndex, const Tizen::Base::String& key);
+
+ /**
+ * @if OSPDEPREC
+ * Sets the Advanced Encryption Standard (AES) key data.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the key value does not need to set for each encryption type.
+ * Instead of using this method, use SetNetworkKey().
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] key The key data to set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The length of the specified @c key exceeds @c 64 bytes.
+ * @exception E_SYSTEM A system error has occurred.
+ * @endif
+ */
+ result SetNetworkKeyAes(const Tizen::Base::String& key);
+
+ /**
+ * @if OSPDEPREC
+ * Sets the Temporal Key Integrity Protocol (TKIP) key data.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the key value does not need to set for each encryption type.
+ * Instead of using this method, use SetNetworkKey().
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] key The key data to set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The length of the specified @c key exceeds @c 64 bytes.
+ * @exception E_SYSTEM A system error has occurred.
+ * @endif
+ */
+ result SetNetworkKeyTkip(const Tizen::Base::String& key);
+
+ /**
+ * Sets the Extensible Authentication Protocol (EAP) method information.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] type The EAP method type
+ * @param[in] userId The user ID to set @n
+ * Its length must not exceed @c 256 bytes.
+ * @param[in] password The password to set @n
+ * Its length must not exceed @c 256 bytes.
+ * @param[in] validateServerCertificate Set to @c true to determine the validation of the server certificate, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The length of the specified @c userId or @c password exceeds @c 256 bytes.
+ * @exception E_UNSUPPORTED_TYPE The input @c type is not supported.
+ * @exception E_SYSTEM A system error has occurred.
+ */
+ result SetEapMethodInfo(WifiEapType type, const Tizen::Base::String& userId, const Tizen::Base::String& password, bool validateServerCertificate = true);
+
+ /**
+ * Sets the network key.
+ *
+ * @since 2.0
+ *
+ * @param[in] key The network key
+ */
+ void SetNetworkKey(const Tizen::Base::String& key);
+
+ /**
+ * Sets the authentication type.
+ *
+ * @since 2.0
+ *
+ * @param[in] authType The authentication type
+ */
+ void SetAuthenticationType(WifiAuthenticationType authType);
+
+ /**
+ * Checks whether the specified instance of %WifiSecurityInfo equals the current instance.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the specified instance equals the current instance, @n
+ * else @c false
+ * @param[in] obj An instance of %WifiSecurityInfo
+ * @remarks This method returns @c false if the specified object is not %WifiSecurityInfo.
+ */
+ virtual bool Equals(const Tizen::Base::Object& obj) const;
+
+ /**
+ * Gets the hash value of the current instance.
+ *
+ * @since 2.0
+ *
+ * @return The hash value of the current instance
+ */
+ virtual int GetHashCode(void) const;
+
+ /**
+ * Assigns the value of the specified instance to the current instance of %WifiSecurityInfo.
+ *
+ * @since 2.0
+ *
+ * @return The reference of this instance
+ * @param[in] rhs An instance of %WifiSecurityInfo
+ */
+ WifiSecurityInfo& operator=(const WifiSecurityInfo& rhs);
private:
- _WifiSecurityInfoImpl* __pWifiSecurityInfoImpl;
+ _WifiSecurityInfoImpl* __pWifiSecurityInfoImpl;
- friend class _WifiSecurityInfoImpl;
+ friend class _WifiSecurityInfoImpl;
}; // WifiSecurityInfo
} } } //Tizen::Net::Wifi
*
* Defines the type of Basic Service Set (BSS).
*
- * @since 2.0
+ * @since 2.0
*/
enum WifiBssType
{
* IEEE 802.11 authentication operates at the link level between IEEE 802.11 stations (STAs).
* IEEE 802.11 does not provide end-to-end (message origin to message destination) or user-to-user authentication.
*
- * @since 2.0
+ * @since 2.0
*/
enum WifiAuthenticationType
{
*
* Defines the IEEE 802.11 encryption that provides the data confidentiality aspects of a closed wired media.
*
- * @since 2.0
+ * @since 2.0
*/
enum WifiEncryptionType
{
*
* Defines the Extensible Authentication Protocol (EAP) method types that provide a specific authentication mechanism.
*
- * @since 2.0
+ * @since 2.0
*/
enum WifiEapType
{
/**
* @if OSPDEPREC
- * @enum WifiWepKeyLen
+ * @enum WifiWepKeyLen
*
* Defines the Wired Equivalent Privacy (WEP) key length.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This enum is deprecated because the WifiSecurityInfo::SetNetworkKeyWep() method is also deprecated.
*
- * @since 2.0
+ * @since 2.0
* @endif
*/
enum WifiWepKeyLen
/**
* @if OSPDEPREC
- * @enum WifiWepKeyIndex
+ * @enum WifiWepKeyIndex
*
* Defines the Wired Equivalent Privacy (WEP) key index.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This enum is deprecated because the WifiSecurityInfo::SetNetworkKeyWep() method is also deprecated.
*
- * @since 2.0
+ * @since 2.0
*
- * @remarks Only WIFI_WEP_KEY_INDEX_1 is supported now.
+ * @remarks Only WIFI_WEP_KEY_INDEX_1 is supported now.
* @endif
*/
enum WifiWepKeyIndex
/**
* @if OSPDEPREC
- * @enum WifiDirectAssociationTerminationReason
+ * @enum WifiDirectAssociationTerminationReason
*
* Defines the reason for the Wi-Fi Direct group client association's termination.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease irrespective of the role (for example, group owner, group client, and so on). @n
- * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these APIs.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because the Wi-Fi Direct APIs have been revised to allow the use of APIs with ease
+ * irrespective of the role (for example, group owner, group client, and so on). @n
+ * Earlier, the Wi-Fi Direct APIs were strictly provided depending on the role and so it was necessary to use these
+ * APIs.
*
- * @since 2.0
+ * @since 2.0
* @endif
*/
enum WifiDirectAssociationTerminationReason
{
- WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_SELF_INITIATED = 0, /**< @if OSPDEPREC The enumerator that is delivered to a group owner or
- * group client who initiates the disassociation request @endif */
- WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_DISCONNECTED /**< @if OSPDEPREC The enumerator that is delivered to a group owner or
- * group client who receives the disassociation request or
- * when a client is disconnected due to out of range or
- * abrupt connection loss to the group owner @endif */
+ WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_SELF_INITIATED = 0, /**< @if OSPDEPREC The enumerator that is delivered to a group
+ * owner or group client who initiates the disassociation
+ * request @endif */
+ WIFI_DIRECT_ASSOCIATION_TERMINATION_REASON_DISCONNECTED /**< @if OSPDEPREC The enumerator that is delivered to a group
+ * owner or group client who receives the disassociation
+ * request or when a client is disconnected due to out of
+ * range or abrupt connection loss to the group owner
+ * @endif */
};
/**
*
* Defines the state of the Wi-Fi connection.
*
- * @since 2.0
+ * @since 2.0
*/
enum WifiConnectionState
{
*
* Defines the mode of the Wi-Fi background system behaviors, mainly about background scanning.
*
- * @since 2.0
+ * @since 2.0
*/
enum WifiSystemScanMode
{
WIFI_SYSTEM_SCAN_MODE_ACTIVE = 0, /**< The background scanning is performed with the short and fixed time interval
- * (10 seconds) during which the Wi-Fi connection is not established @n The Wi-Fi target picker
- * popup for connection is not launched when Wi-Fi is turned on. @n
+ * (10 seconds) during which the Wi-Fi connection is not established @n The Wi-Fi
+ * target picker popup for connection is not launched when Wi-Fi is turned on. @n
* Generally, this mode is for the case that the Wi-Fi setting app is running on
* foreground. */
WIFI_SYSTEM_SCAN_MODE_PASSIVE /**< The background scanning is performed with the exponential backoff time interval
- * (4, 8, ..., and finally 128 seconds) during which the Wi-Fi connection is not established @n
+ * (4, 8, ..., and finally 128 seconds) during which the Wi-Fi connection is not
+ * established @n
* The Wi-Fi target picker popup for connection is launched when Wi-Fi is turned on. @n
* Generally, this mode is for the both cases that the Wi-Fi setting app is running on
* background and terminated. */
projects / platform / framework / native / net.git / commitdiff