diff options
author | Paul Fertser <fercerpav@gmail.com> | 2009-08-11 10:19:13 +0400 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2009-08-12 14:56:25 -0700 |
commit | 42d950cabe60436af961e71bd146a0ce19e963f7 (patch) | |
tree | 378fc06303d37e6d39c2bcad9372237c70acc1b3 /doc | |
parent | 5929a3c52d687b1fa33587ef89ef6363fb5014dc (diff) | |
download | bluez-42d950cabe60436af961e71bd146a0ce19e963f7.tar.gz |
Improve network API documentation
Add information about ways of specifying UUIDs and about
disconnect conditions.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/network-api.txt | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/network-api.txt b/doc/network-api.txt index 72711931..ae2be4f5 100644 --- a/doc/network-api.txt +++ b/doc/network-api.txt @@ -17,6 +17,14 @@ Methods string Connect(string uuid) device name. Examples of the device 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 |