aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPaul Stewart <pstew@chromium.org>2013-11-18 22:31:25 (GMT)
committerJouni Malinen <j@w1.fi>2013-11-20 14:39:34 (GMT)
commitca9c14fb0ac5ef75ad75c4b970272c9a52adad73 (patch)
tree2b3c4f9f5127e2a5a04a3b52cfabd50af4f8595d /doc
parent8c30ab492c8e6ded14744b4239d701e9d10275ba (diff)
downloadhostap-ca9c14fb0ac5ef75ad75c4b970272c9a52adad73.zip
hostap-ca9c14fb0ac5ef75ad75c4b970272c9a52adad73.tar.gz
hostap-ca9c14fb0ac5ef75ad75c4b970272c9a52adad73.tar.bz2
dbus_new: Add documentation for D-Bus TDLS methods
Signed-hostap: Paul Stewart <pstew@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/dbus.doxygen67
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 7e4c7c9..87093ed 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -334,6 +334,73 @@ fi.w1.wpa_supplicant1.CreateInterface.
</dl>
</li>
<li>
+ <h3>TDLSDiscover ( s : peer_address ) --> nothing</h3>
+ <p>Initiate a TDLS discovery for a peer.</p>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>s : peer_address</dt>
+ <dd>MAC address for the peer to perform TDLS discovery.</dd>
+ </dl>
+ <h4>Possible errors</h4>
+ <dl>
+ <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+ <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+ <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
+ <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
+ </dl>
+ </li>
+ <li>
+ <h3>TDLSSetup ( s : peer_address ) --> nothing</h3>
+ <p>Setup a TDLS session for a peer.</p>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>s : peer_address</dt>
+ <dd>MAC address for the peer to perform TDLS setup.</dd>
+ </dl>
+ <h4>Possible errors</h4>
+ <dl>
+ <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+ <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+ <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
+ <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
+ </dl>
+ </li>
+ <li>
+ <h3>TDLSStatus ( s : peer_address ) --> s</h3>
+ <p>Return TDLS status with respect to a peer.</p>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>s : peer_address</dt>
+ <dd>MAC address for the peer for which status is requested.</dd>
+ </dl>
+ <h4>Returns</h4>
+ <dl>
+ <dt>s : status</dt>
+ <dd>Current status of the TDLS link with the selected peer.</dd>
+ </dl>
+ <h4>Possible errors</h4>
+ <dl>
+ <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+ <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+ </dl>
+ </li>
+ <li>
+ <h3>TDLSTeardown ( s : peer_address ) --> nothing</h3>
+ <p>Tear down a TDLS session with a peer.</p>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>s : peer_address</dt>
+ <dd>MAC address for the peer to tear down TDLS connectivity with.</dd>
+ </dl>
+ <h4>Possible errors</h4>
+ <dl>
+ <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+ <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+ <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
+ <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
+ </dl>
+ </li>
+ <li>
<h3>EAPLogoff ( ) --> nothing</h3>
<p>IEEE 802.1X EAPOL state machine logoff.</p>
</li>