summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-05-29 21:15:47 +0000
committerMarcel Holtmann <marcel@holtmann.org>2008-05-29 21:15:47 +0000
commit07d1404659065104580ce7b24315af99dcd02ec0 (patch)
tree05b28ac7041d7e6b2b63f39f31515bab8645b31d /doc
parent7d1a9d56719aea39ecd38c8dafffee9de898e68b (diff)
Remove CancelConnect methods
Diffstat (limited to 'doc')
-rw-r--r--doc/input-api.txt10
-rw-r--r--doc/network-api.txt10
-rw-r--r--doc/serial-api.txt6
3 files changed, 12 insertions, 14 deletions
diff --git a/doc/input-api.txt b/doc/input-api.txt
index e9ad0aa7..65f87e7d 100644
--- a/doc/input-api.txt
+++ b/doc/input-api.txt
@@ -18,17 +18,13 @@ Methods void Connect()
Possible errors: org.bluez.Error.AlreadyConnected
org.bluez.Error.ConnectionAttemptFailed
- void CancelConnect()
-
- Abort connection attempt in case of errors or
- timeouts in the client.
-
- Possible errors: org.bluez.Error.Failed
-
void Disconnect()
Disconnect from the input 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
bool IsConnected()
diff --git a/doc/network-api.txt b/doc/network-api.txt
index 3aee9bac..11a362c6 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -18,17 +18,13 @@ Methods void Connect()
Possible errors: org.bluez.Error.AlreadyConnected
org.bluez.Error.ConnectionAttemptFailed
- void CancelConnect()
-
- Abort connection attempt in case of errors or
- timeouts in the client.
-
- Possible errors: org.bluez.Error.Failed
-
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
bool IsConnected()
diff --git a/doc/serial-api.txt b/doc/serial-api.txt
index 7be4277d..21c4f220 100644
--- a/doc/serial-api.txt
+++ b/doc/serial-api.txt
@@ -27,5 +27,11 @@ Methods string Connect(string uuid)
Disconnect a RFCOMM TTY device that has been
created by Connect method.
+ To abort a connection attempt in case of errors or
+ timeouts in the client it is fine to call this method.
+
+ In that case the UUID of the Connect method should
+ be suplied instead of the TTY device.
+
Possible errors: org.bluez.Error.InvalidArguments
org.bluez.Error.DoesNotExist