diff options
| author | Johan Hedberg <johan.hedberg@intel.com> | 2012-12-21 01:21:32 +0200 |
|---|---|---|
| committer | Johan Hedberg <johan.hedberg@intel.com> | 2012-12-21 01:51:58 +0200 |
| commit | 0624791ea6e917d6c9ecb8e7e6e5a1327199448d (patch) | |
| tree | ad82a4cb99f513a42e32ad768443b74059322803 /doc/network-api.txt | |
| parent | 98b4797764ccb114c9a1ee00d911d0f88c3f7180 (diff) | |
| download | bluez-0624791ea6e917d6c9ecb8e7e6e5a1327199448d.tar.gz | |
Revert "network: Remove Network.Connect and Network.Disconnect"
This reverts commit 9c62de94e5044038bcaae6cd6c0ec783fbee607a.
For convenience (mainly for ConnMan) bring back
Network1.Connect/Disconnect since they also give the interface name
directly.
Diffstat (limited to 'doc/network-api.txt')
| -rw-r--r-- | doc/network-api.txt | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/network-api.txt b/doc/network-api.txt index 2ec59abcb..109da28bf 100644 --- a/doc/network-api.txt +++ b/doc/network-api.txt @@ -9,6 +9,32 @@ Service org.bluez Interface org.bluez.Network1 Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX +Methods string Connect(string uuid) + + Connect to the network device and return the network + interface name. Examples of the interface name are + bnep0, bnep1 etc. + + uuid can be either one of "gn", "panu" or "nap" (case + insensitive) or a traditional string representation of + UUID or a hexadecimal number. + + The connection will be closed and network device + released either upon calling Disconnect() or when + the client disappears from the message bus. + + Possible errors: org.bluez.Error.AlreadyConnected + org.bluez.Error.ConnectionAttemptFailed + + void Disconnect() + + Disconnect from the network device. + + To abort a connection attempt in case of errors or + timeouts in the client it is fine to call this method. + + Possible errors: org.bluez.Error.Failed + Properties boolean Connected [readonly] Indicates if the device is connected. |