Net_Wifi
[ class tree: Net_Wifi ] [ index: Net_Wifi ] [ all elements ]

Source for file Config.php

Documentation is available at Config.php

  1. <?php
  2. /**
  3. * Configuration settings of a wifi network interface.
  4. *
  5. * PHP Versions 4 and 5
  6. *
  7. @category Networking
  8. @package  Net_Wifi
  9. @author   Christian Weiske <cweiske@php.net>
  10. @license  http://www.gnu.org/copyleft/lesser.html  LGPL License 2.1
  11. @version  CVS: $Id$
  12. @link     http://pear.php.net/package/Net_Wifi
  13. */
  14.  
  15. /**
  16. * Configuration settings of a wifi network interface.
  17. *
  18. @category Networking
  19. @package  Net_Wifi
  20. @author   Christian Weiske <cweiske@php.net>
  21. @license  http://www.gnu.org/copyleft/lesser.html  LGPL License 2.1
  22. @link     http://pear.php.net/package/Net_Wifi
  23. */
  24. {
  25.     /**
  26.     *   If the interface is activated.
  27.     *   Some notebooks have a button which deactivates wifi, this is recognized here.
  28.     *   Note that this setting can't be read by all drivers, and so
  29.     *    it's "true" if it can't be determined. You can be sure that it's deactivated
  30.     *    if this setting is false, but not that it's activated if it's true
  31.     *   @var boolean 
  32.     */
  33.     var $activated = true;
  34.  
  35.     /**
  36.     *   MAC address of the associated access point.
  37.     *   @var string 
  38.     */
  39.     var $ap = null;
  40.  
  41.     /**
  42.     *   If the interface is connected to an access point or an ad-hoc network.
  43.     *   @var boolean 
  44.     */
  45.     var $associated = false;
  46.  
  47.     /**
  48.     *   Network type.
  49.     *   Can be "master" or "ad-hoc" (without quotes)
  50.     *   @var string 
  51.     */
  52.     var $mode = null;
  53.  
  54.     /**
  55.     *   The nickname which the interface (computer) uses.
  56.     *   Something like a computer name
  57.     *   @var string 
  58.     */
  59.     var $nick = null;
  60.  
  61.     /**
  62.     *   Noise level in dBm - how much the signal is disturbed
  63.     *   example: -249
  64.     *   @var int 
  65.     */
  66.     var $noise = null;
  67.  
  68.     /**
  69.     *   Other packets lost in relation with specific wireless operations.
  70.     *   @var int 
  71.     */
  72.     var $packages_invalid_misc = 0;
  73.  
  74.     /**
  75.     *   Number of periodic beacons from the Cell or the Access Point we have
  76.     *   missed. Beacons are sent at regular intervals to maintain the cell
  77.     *   coordination, failure to receive them usually indicates that the card
  78.     *   is out of range.
  79.     *   @var int 
  80.     */
  81.     var $packages_missed_beacon = 0;
  82.  
  83.     /**
  84.     *   Number of packets that the hardware was unable to decrypt.
  85.     *   This can be used to detect invalid encryption
  86.     *   settings.
  87.     *   @var int 
  88.     */
  89.     var $packages_rx_invalid_crypt = null;
  90.  
  91.     /**
  92.     *   Number of packets for which the hardware was not able to properly
  93.     *   re-assemble the link layer fragments (most likely
  94.     *   one was missing).
  95.     *   @var int 
  96.     */
  97.     var $packages_rx_invalid_frag = null;
  98.  
  99.     /**
  100.     *   Number of packets received with a different NWID or ESSID.
  101.     *   Used to detect configuration problems or adjacent
  102.     *   network existence (on the same frequency).
  103.     *   @var int 
  104.     */
  105.     var $packages_rx_invalid_nwid = null;
  106.  
  107.     /**
  108.     *   Number of packages that needed to be re-submitted repeatedly again
  109.     *   and again, because no ACK was received for them.
  110.     *   You have a bad connection or are connecting long distance.
  111.     *   @var int 
  112.     */
  113.     var $packages_tx_excessive_retries = null;
  114.  
  115.     /**
  116.     *   Power setting of the interface.
  117.     *   @var int 
  118.     */
  119.     var $power = null;
  120.  
  121.     /**
  122.     *   Protocol version which is used for connection.
  123.     *   example: "IEEE 802.11g" without quotes
  124.     *   @var string 
  125.     */
  126.     var $protocol = null;
  127.  
  128.     /**
  129.     *   The bit rate of the connection.
  130.     *   @var float 
  131.     */
  132.     var $rate = null;
  133.  
  134.     /**
  135.     *   Signal strength in dBm.
  136.     *   example: -59
  137.     *   @var int 
  138.     */
  139.     var $rssi = null;
  140.  
  141.     /**
  142.     *   "Service Set IDentifier" of the cell which identifies current network.
  143.     *   Max. 32 alphanumeric characters
  144.     *   example: "My Network" (without quotes)
  145.     *   @var string 
  146.     */
  147.     var $ssid = null;
  148.  
  149. }//class Net_Wifi_Config
  150. ?>

Documentation generated on Wed, 19 Jun 2013 08:30:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.