jeltz/hostap
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Add D-Bus documentation for Probe Request reporting

Browse source 
Commit 2d43d37ff2 ('DBus: Add ability to
report probe requests') added this capability, but forgot to document
it.

Signed-off-by: Jouni Malinen <j@w1.fi>
This commit is contained in:
Jouni Malinen 2014-12-30 13:56:42 +02:00
parent 24a97d6ff2
commit 9f972b45ca
1 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
doc/dbus.doxygen
View file

@ -511,6 +511,30 @@ fi.w1.wpa_supplicant1.CreateInterface.
<dd>Maximum age in seconds for BSS entries to keep in cache (0 = remove all entries).</dd> <dd>Maximum age in seconds for BSS entries to keep in cache (0 = remove all entries).</dd>
</dl> </dl>
</li> </li>
<li>
<h3>SubscribeProbeReq ( ) --> nothing</h3>
<p>Subscribe to receive Probe Request events. This is needed in addition to registering a signal handler for the ProbeRequest signal to avoid flooding D-Bus with all Probe Request indications when no application is interested in them.</p>
<h4>Possible errors</h4>
<dl>
<dt>fi.w1.wpa_supplicant1.SubscriptionInUse</dt>
<dd>Another application is already subscribed.</dd>
<dt>fi.w1.wpa_supplicant1.NoMemory</dt>
<dd>Needed memory was not possible to get allocated.</dd>
</dl>
</li>
<li>
<h3>UnsubscribeProbeReq ( ) --> nothing</h3>
<p>Unsubscribe from receiving Probe Request events.</p>
<h4>Possible errors</h4>
<dl>
<dt>fi.w1.wpa_supplicant1.NoSubscription</dt>
<dd>No subscription in place.</dd>
<dt>fi.w1.wpa_supplicant1.SubscriptionNotYou</dt>
<dd>Subscription in place, but for another process.</dd>
</dl>
</li>
</ul> </ul>
\subsection dbus_interface_properties Properties \subsection dbus_interface_properties Properties
@ -778,6 +802,16 @@ fi.w1.wpa_supplicant1.CreateInterface.
<dd>Human readable information about the requested information.</dd> <dd>Human readable information about the requested information.</dd>
</dl> </dl>
</li> </li>
<li>
<h3>ProbeRequest ( a{sv} : args )</h3>
<p>Information about a received Probe Request frame. This signal is delivered only to a single application that has subscribed to received the events with SubscribeProbeReq().</p>
<h4>Arguments</h4>
<dl>
<dt>a{sv} : args</dt>
<dd>A dictionary with pairs of field names and their values. Possible dictionary keys are: "addr", "dst", "bssid", "ies", "signal".</dd>
</dl>
</li>
</ul> </ul>