path: root/doc
diff options
authorNishant Chaprana <n.chaprana@samsung.com>2016-06-20 04:48:21 (GMT)
committerJouni Malinen <j@w1.fi>2016-06-24 16:02:58 (GMT)
commit82b9ec3125d628fdf1773b1d1184fbc1579dc3c8 (patch)
tree4db9c80121e5112022323275b48919815d435bbe /doc
parente18d1708486ce7d02c405ca31a5ac06c6d64e2d2 (diff)
D-Bus: Add DeviceFoundProperties signal for discovered peers
This signal sends the peer properties to applications for discovered peers. The signature of this event is "oa{sv}". This event is needed because the current DeviceFound signal provides only the peer object path. If there are many peers in range there will be many DeviceFound signals and for each DeviceFound signal, applications would need to use GetAll to fetch peer properties. Doing this many times would create extra load over application as well as over wpa_supplicant, so it is better to send peer properties in the event so that applications can extract found peer information without extra steps. The existing DeviceFound signal is left as-is to avoid changing its signature. The issue is not applicable to the control interface because the P2P-DEVICE-FOUND event includes peer info in it, but over D-Bus interface DeviceFound provides only the peer object. Signed-off-by: Nishant Chaprana <n.chaprana@samsung.com>
Diffstat (limited to 'doc')
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 28ee371..e6c70f9 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -1632,6 +1632,20 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
+ <h3>DeviceFoundProperties ( o : path, a{sv} : properties )</h3>
+ <p>A new peer device has been found.</p>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>o : path</dt>
+ <dd>A D-Bus path to an object representing the found peer device.</dd>
+ </dl>
+ <dl>
+ <dt>a{sv} : properties</dt>
+ <dd>A dictionary containing properties of the found peer device.</dd>
+ </dl>
+ </li>
+ <li>
<h3>DeviceLost ( o : path )</h3>