docs: added documentation for Ad-Hoc interface

This commit is contained in:
James Prestwood 2018-07-17 14:16:04 -07:00 committed by Denis Kenzior
parent bf3a171e3a
commit 6051bdb360
1 changed files with 41 additions and 0 deletions

41
doc/adhoc-api.txt Normal file
View File

@ -0,0 +1,41 @@
Ad-Hoc hiearchy
===============
Service net.connman.iwd
Interface net.connman.AdHoc [Experimental]
Object path /{phy0,phy1,...}/{1,2,...}
Methods void Start(string ssid, string psk)
Start or join an existing Ad-Hoc network called
'ssid' with a passphrase of 'psk'.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.InvalidArgs
net.connman.iwd.AlreadyExists
void StartOpen(string ssid)
Start or join an existing open Ad-Hoc network called
'ssid'
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.InvalidArgs
net.connman.iwd.AlreadyExists
void Stop()
Leave an Ad-Hoc network. Note: Calling Stop() will
not bring down the Ad-Hoc interface. The device
mode must be switched to non-AdHoc mode.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.InvalidArgs
Properties string[] ConnectedPeers [readonly]
List of peer MAC addresses that have successfully
connected to the Ad-Hoc network.