WPS UPnP: Throttle WLANEvent notifications to 5 per second

[libeap.git] / doc / dbus.doxygen

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 322d3de..eeea200 100644 (file)
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -202,7 +202,7 @@ fi.w1.wpa_supplicant1.CreateInterface.
        <p>Disassociates the interface from current network.</p>
        <h4>Possible errors</h4>
        <dl>
-         <dt>fi.w1.wpa_supplicant1.Interface.NotConnected</dt>
+         <dt>fi.w1.wpa_supplicant1.NotConnected</dt>
          <dd>Interface is not connected to any network.</dd>
        </dl>
       </li>
@@ -239,7 +239,7 @@ fi.w1.wpa_supplicant1.CreateInterface.
        </dl>
        <h4>Possible errors</h4>
        <dl>
-         <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt>
+         <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt>
          <dd>A passed path doesn't point to any network object.</dd>
          <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
          <dd>A passed path doesn't point to any network object.</dd>
@@ -258,7 +258,7 @@ fi.w1.wpa_supplicant1.CreateInterface.
        </dl>
        <h4>Possible errors</h4>
        <dl>
-         <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt>
+         <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt>
          <dd>A passed path doesn't point to any network object.</dd>
          <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
          <dd>A passed path doesn't point to any network object.</dd>
@@ -277,7 +277,7 @@ fi.w1.wpa_supplicant1.CreateInterface.
        </dl>
        <h4>Possible errors</h4>
        <dl>
-         <dt>fi.w1.wpa_supplicant1.Interface.BlobExists</dt>
+         <dt>fi.w1.wpa_supplicant1.BlobExists</dt>
          <dd>A blob with the specified name already exists.</dd>
        </dl>
       </li>
@@ -292,7 +292,7 @@ fi.w1.wpa_supplicant1.CreateInterface.
        </dl>
        <h4>Possible errors</h4>
        <dl>
-         <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt>
+         <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt>
          <dd>A blob with the specified name doesn't exist.</dd>
        </dl>
       </li>
@@ -312,7 +312,7 @@ fi.w1.wpa_supplicant1.CreateInterface.
        </dl>
        <h4>Possible errors</h4>
        <dl>
-         <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt>
+         <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt>
          <dd>A blob with the specified name doesn't exist.</dd>
        </dl>
       </li>
@@ -328,7 +328,7 @@ fi.w1.wpa_supplicant1.CreateInterface.
          <tr><th>Key</th><th>Value type</th><th>Description</th>
          <tr><td>Pairwise</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "none"</td>
          <tr><td>Group</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "wep104", "wep40"</td>
-         <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-eap", "ieee8021x", "wpa-none", "wps", "none"</td>
+         <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "ieee8021x", "wpa-none", "wps", "none"</td>
          <tr><td>Protocol</td><td>as</td><td>Possible array elements: "rsn", "wpa"</td>
          <tr><td>AuthAlg</td><td>as</td><td>Possible array elements: "open", "shared", "leap"</td>
          <tr><td>Scan</td><td>as</td><td>Possible array elements: "active", "passive", "ssid"</td>
@@ -603,7 +603,7 @@ Interface implemented by objects related to network interface added to
     </ul>
 
 
-\section dbus_bss fi.w1.wpa_supplicant1.Interface.BSS
+\section dbus_bss fi.w1.wpa_supplicant1.BSS
 
 Interface implemented by objects representing a scanned BSSs, i.e.,
 scan results.
@@ -620,16 +620,27 @@ scan results.
        <p>SSID of the BSS.</p>
       </li>
       <li>
-       <h3>WPAIE - ay - (read)</h3>
-       <p>WPA information element of the BSS. The second byte contain number of bytes following it.</p>
+       <h3>WPA - a{sv} - (read)</h3>
+       <p>WPA information of the BSS. Empty dictionary indicates no WPA support. Dictionary entries are:</p>
+       <table>
+         <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-none"</td>
+         <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td>
+         <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td>
+       </table>
       </li>
       <li>
-       <h3>RSNIE - ay - (read)</h3>
-       <p>RSN information element of the BSS. The second byte contain number of bytes following it.</p>
+       <h3>RSN - a{sv} - (read)</h3>
+       <p>RSN information of the BSS. Empty dictionary indicates no RSN support. Dictionary entries are:</p>
+       <table>
+         <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-ft-psk", "wpa-ft-eap", "wpa-psk-sha256", "wpa-eap-sha256",</td>
+         <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td>
+         <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td>
+         <tr><td>MgmtGroup</td><td>s</td><td>Mangement frames cipher suite. Possible values are: "aes128cmac"</td>
+       </table>
       </li>
       <li>
-       <h3>WPSIE - ay - (read)</h3>
-       <p>WPS information element of the BSS. The second byte contain number of bytes following it.</p>
+       <h3>IEs - ay - (read)</h3>
+       <p>All IEs of the BSS as a chain of TLVs</p>
       </li>
       <li>
        <h3>Privacy - b - (read)</h3>
@@ -668,7 +679,7 @@ scan results.
     </ul>
 
 
-\section dbus_network fi.w1.wpa_supplicant1.Interface.Network
+\section dbus_network fi.w1.wpa_supplicant1.Network
 
 Interface implemented by objects representing configured networks,
 i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork.