inc/FNetWifi.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file    FNetWifi.h
  20  * @brief   This is the header file for the %Wifi namespace.
  21  *
  22  * This header file contains the declarations and descriptions of the %Wifi namespace.
  23  */
  24
  25 #ifndef _FNET_WIFI_H_
  26 #define _FNET_WIFI_H_
  27
  28 #include <FNetWifiWifiTypes.h>
  29 #include <FNetWifiWifiManager.h>
  30 #include <FNetWifiWifiBssInfo.h>
  31 #include <FNetWifiWifiSecurityInfo.h>
  32 #include <FNetWifiIWifiManagerEventListener.h>
  33 #include <FNetWifiIWifiSystemMonitoringEventListener.h>
  34 #include <FNetWifiWifiNetAccountInfo.h>
  35 #include <FNetWifiIWifiDirectDeviceListener.h>
  36 #include <FNetWifiIWifiDirectGroupOwnerListener.h>
  37 #include <FNetWifiIWifiDirectGroupClientListener.h>
  38 #include <FNetWifiWifiDirectDevice.h>
  39 #include <FNetWifiWifiDirectDeviceInfo.h>
  40 #include <FNetWifiWifiDirectDeviceManager.h>
  41 #include <FNetWifiWifiDirectGroupClient.h>
  42 #include <FNetWifiWifiDirectGroupInfo.h>
  43 #include <FNetWifiWifiDirectGroupMember.h>
  44 #include <FNetWifiWifiDirectGroupOwner.h>
  45
  46 namespace Tizen { namespace Net
  47 {
  48
  49 /**
  50   * @namespace   Tizen::Net::Wifi
  51   * @brief       This namespace contains the classes and interfaces for the Wi-Fi management and Wi-Fi Direct functionalities.
  52   * @since       2.0
  53   *
  54   * @remarks     @b Header @b %file: @b \#include @b <FNet.h> @n
  55   *              @b Library : @b osp-wifi @n
  56   *
  57   * The %Net::Wifi namespace contains the classes and interfaces for Wi-Fi management and Wi-Fi Direct functionalities. It
  58   * provides a rich set of methods to manage the Wi-Fi devices and accounts, and to communicate over a Wi-Fi channel.
  59   * Additionally, the Wi-Fi Direct functionalities are provided to manage the Wi-Fi Direct device, create a Wi-Fi Direct group,
  60   * scan Wi-Fi Direct devices, associate to a Wi-Fi Direct group owner, get the WifiDirectGroupOwner or the WifiDirectGroupClient
  61   * instance, and allow the listener to get the events related to Wi-Fi Direct device and group.
  62   *
  63   * This namespace provides the Wi-Fi and Wi-Fi Direct functionalities. The Wi-Fi related operations are provided by classes like
  64   * WifiManager and WifiSecurityInfo. The Wi-Fi Direct related operations are provided by classes like WifiDirectDevice.
  65   *
  66   * For more information on the %Wifi namespace features, see
  67   * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a> and
  68   * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_direct_connectivity.htm">Wi-Fi Direct Connectivity</a>.
  69   *
  70   * The following diagram illustrates the relationships between the Wi-Fi classes belonging to the %Wifi namespace.
  71   * @image html net_wi-fi_using_the_apis_classdiagram.png
  72   *
  73   * The following diagram illustrates the relationships between the Wi-Fi Direct classes belonging to the %Wifi namespace.
  74   * @image html net_wi-fi_direct_using_the_apis_classdiagram.png
  75   *
  76   */
  77 namespace Wifi
  78 {
  79
  80 } } } // Tizen::Net::Wifi
  81
  82 #endif // _FNET_WIFI_H_