summaryrefslogtreecommitdiffstats
path: root/hcid/dbus-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2006-03-09 18:44:17 +0000
committerMarcel Holtmann <marcel@holtmann.org>2006-03-09 18:44:17 +0000
commit9ebce18255f79c4aea900840a28ff6393ccea8d8 (patch)
tree229477f689f10e0e4802bea7b62598a266586e39 /hcid/dbus-api.txt
parent45bf9fe5ed606eb9bb3433cecb7a8b222ce15864 (diff)
Update the error documentation
Diffstat (limited to 'hcid/dbus-api.txt')
-rw-r--r--hcid/dbus-api.txt33
1 files changed, 25 insertions, 8 deletions
diff --git a/hcid/dbus-api.txt b/hcid/dbus-api.txt
index 7b132ca0..824c7618 100644
--- a/hcid/dbus-api.txt
+++ b/hcid/dbus-api.txt
@@ -76,11 +76,28 @@ Errors Failed
ConnectionAttemptFailed
- BondingAlreadyExists
+ AlreadyExists
- BondingDoesNotExists
+ Error returned if a record for a specific procedure
+ already exists and it has been tried create a new
+ one. The error message however should indicate the
+ procedure that fails. For example "Bonding already
+ exists"
- BondingInProgress
+ DoesNotExists
+
+ Error returned if a record for a specifc procedure
+ doesn't exists. The error message however should
+ indicate the procedure that fails. For example
+ "Bonding does not exits".
+
+ InProgress
+
+ Error returned if an operation is in progress. Since
+ this is a generic error that can be used in various
+ situations, the error message should be more clear
+ about what is in progress. For example "Bonding in
+ progress".
AuthenticationFailed
@@ -487,8 +504,8 @@ Methods string GetAddress()
Possible errors: org.bluez.Error.Failed
org.bluez.Error.UnknownAddress
- org.bluez.Error.BondingAlreadyExists
- org.bluez.Error.BondingInProgress
+ org.bluez.Error.AlreadyExists
+ org.bluez.Error.InProgress
org.bluez.Error.ConnectionAttemptFailed
org.bluez.Error.AuthenticationFailed
org.bluez.Error.AuthenticationTimeout
@@ -520,7 +537,7 @@ Methods string GetAddress()
BondingRemoved signal.
Possible errors: org.bluez.Error.UnknownAddress
- org.bluez.Error.BondingDoesNotExists
+ org.bluez.Error.DoesNotExists
boolean HasBonding(string address)
@@ -541,7 +558,7 @@ Methods string GetAddress()
pairing process.
Possible errors: org.bluez.Error.UnknownAddress
- org.bluez.Error.BondingDoesNotExists
+ org.bluez.Error.DoesNotExists
uint8 GetEncryptionKeySize(string address)
@@ -552,7 +569,7 @@ Methods string GetAddress()
Possible errors: org.bluez.Error.UnknownAddress
org.bluez.Error.NotConnected
- org.bluez.Error.BondingDoesNotExists
+ org.bluez.Error.DoesNotExists
void DiscoverDevices()