path: root/doc
diff options
authorPurushottam Kushwaha <p.kushwaha@samsung.com>2015-06-16 11:35:56 (GMT)
committerJouni Malinen <j@w1.fi>2015-06-19 09:55:54 (GMT)
commit4e7175827ed56ec67a8b0e806869cf3f0c4b30a3 (patch)
tree7597160725067ab38f3bccde13472cf2f8fd570f /doc
parentf0a79c9403bdb36045a7e7061ac5a299fadbebd5 (diff)
dbus: Add RemoveClient method to remove a client from local GO
This is equivalent to the P2P_REMOVE_CLIENT command on control interface. This can be used to remove the specified client [as object path or string format interface address] from all groups (operating and persistent) from the local GO. Argument(s): peer[object path] OR iface[string format MAC address] Signed-off-by: Purushottam Kushwaha <p.kushwaha@samsung.com> Signed-off-by: Jijo Jacob <jijo.jacob@samsung.com>
Diffstat (limited to 'doc')
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 7355dbb..3a08ad7 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -1119,6 +1119,23 @@ Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
+ <h3>RemoveClient ( a{sv} : args ) --> nothing</h3>
+ <p>Remove the client from all groups (operating and persistent) from the local GO.</p>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>a{sv} : args</dt>
+ <dd>
+ A dictionary with parameters for removing a client:
+ <table>
+ <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
+ <tr><td>peer</td><td>o</td><td>Object path for peer's P2P Device Address</td><td>yes</td></tr>
+ <tr><td>iface</td><td>s</td><td>Interface address[MAC Address format] of the peer to be disconnected. Required if object path is not provided.</td><td>no</td></tr>
+ </table>
+ </dd>
+ </dl>
+ </li>
+ <li>
<h3>Flush ( nothing ) --> nothing</h3>
<p>Flush P2P peer table and state.</p>