summaryrefslogtreecommitdiffstats
path: root/hcid/dbus-api.txt
diff options
context:
space:
mode:
Diffstat (limited to 'hcid/dbus-api.txt')
-rw-r--r--hcid/dbus-api.txt117
1 files changed, 72 insertions, 45 deletions
diff --git a/hcid/dbus-api.txt b/hcid/dbus-api.txt
index 9a29916d..51a2eff7 100644
--- a/hcid/dbus-api.txt
+++ b/hcid/dbus-api.txt
@@ -51,84 +51,111 @@ Error hierarchy
Interface org.bluez.Error
-Errors Failed
+Shared Errors (Can be thrown by hcid or any bluetooth service)
+
+ DeviceUnreachable
+
+ The remote device is either powered down or out of range.
- An unknown error occured. The error messages is
- taken from the strerror(errno) function.
+ AlreadyConnected
+ A connection request has been received on an already
+ connected device.
- InvalidArguments
+ ConnectionAttemptFailed
- Error returned when the argument list is invalid or
- out of specification for the method.
+ An unexpected error (other than DeviceUnreachable) error
+ has occured while attempting a connection to a device.
- NotAuthorized
+ NotConnected
+ The remote device is not connected, while the method call
+ would expect it to be, or is not in the expected state to
+ perform the action.
- Error returned when the caller of a method is not
- authorized. This might happen if a caller tries to
- terminate a connection that it hasn't created.
+ 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".
+
+ InvalidArguments
+
+ The DBUS request does not contain the right number of
+ arguments with the right type, or the arguments are there
+ but their value is wrong, or does not makes sense in the
+ current context.
OutOfMemory
Error returned when a memory allocation via malloc()
fails. This error is similar to ENOMEM.
- NoSuchAdapter
+ NotAvailable
- Error returned when the requested adapter doesn't
- exists. This error is similar to ENODEV.
+ Error returned when a specified record is not
+ available.
- NotReady
+ NotSupported
+
+ The remote device does not support the expected
+ feature.
- Error returned when the adapter is DOWN.
+ AlreadyExists
+ One of the requested elements already exists
- NotAvailable
+ DoesNotExist
+ One of the requested elements does not exist
- Error returned when a specified record is not
- available.
+ Canceled
+ The operation was canceled.
- NotConnected
+ Failed
- Error returned when the remote device isn't connected
- at the moment.
+ This is a the most generic error.
+ It is thrown when something unexpected happens.
- ConnectionAttemptFailed
- AlreadyExists
+Hcid specific Errors (Can be thrown by hcid only)
- 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"
+ NotReady
- DoesNotExist
+ Error returned when the adapter is DOWN.
- Error returned if a record for a specifc procedure
- doesn't exist. The error message however should
- indicate the procedure that fails. For example
- "Bonding does not exist".
+ UnknwownMethod
+
+ This is an experimental method.
- InProgress
+ NotAuthorized
- 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".
+ Error returned when the caller of a method is not
+ authorized. This might happen if a caller tries to
+ terminate a connection that it hasn't created.
- NotSupported
- The feature is not supported by the remote device
+ Rejected
- AuthenticationFailed
+ NoSuchAdapter
- AuthenticationTimeout
+ Error returned when the requested adapter doesn't
+ exists. This error is similar to ENODEV.
- AuthenticationRejected
+ NoSuchService
+
+ RequestDeferred
+
+ NotInProgress
+
+ UnsupportedMajorClass
AuthenticationCanceled
- UnsupportedMajorClass
+ AuthenticationFailed
+
+ AuthenticationTimeout
+
+ AuthenticationRejected
+ RepeatedAttempts
Manager hierarchy
=================