From ac7762f22853dec7233af0c4669d006633b25c79 Mon Sep 17 00:00:00 2001 From: Tom Gundersen Date: Sun, 23 Apr 2017 17:05:16 +0200 Subject: [PATCH 2/3] docs: document the drivers error codes Document the possible error code during normal operations. Error codes due to internal errors or configuration errors are not documented and are not really meant for the client to know what to do with. Signed-off-by: Tom Gundersen --- doc/dbus-specification.xml | 314 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 307 insertions(+), 7 deletions(-) diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml index 7759de36..f730f580 100644 --- a/doc/dbus-specification.xml +++ b/doc/dbus-specification.xml @@ -5247,6 +5247,27 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.LimitsExceeded + The maximum number of active connections have been exceeded + + + org.freedesktop.DBus.Error.Failed + The client is already registered on the bus + + + + Before an application is able to send messages to other applications @@ -5313,6 +5334,31 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.InvalidArgs + The requested name is reserved or not a valid well-known name + + + org.freedesktop.DBus.Error.AccessDenied + Application is not allowed to own name + + + org.freedesktop.DBus.Error.LimitsExceeded + The maximum number of names have been exceeded + + + + Ask the message bus to assign the given name to the method caller. Each @@ -5546,6 +5592,23 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.InvalidArgs + The name is reserved or not a valid well-known name + + + + Ask the message bus to release the method caller's claim to the given @@ -5641,6 +5704,23 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.NameHasNoOwner + The name does not exist + + + + List the connections currently queued for a bus name (see @@ -5919,6 +5999,31 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.LimitsExceeded + The maximum number of pending activations has been exceeded + + + org.freedesktop.DBus.Error.ServiceUnknown + The name is not activatable + + + org.freedesktop.DBus.Error.AccessDenied + The caller does not have permission to activate the service + + + + Tries to launch the executable associated with a name (service activation), as an explicit request. This is an alternative to relying on auto-starting. For more information on how services @@ -5996,6 +6101,23 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.AccessDenied + Invalid object path, or the caller does not have permission to alter the activation environemnt + + + + Normally, session bus activated services inherit the environment of the bus daemon. This method adds to or modifies that environment when activating services. @@ -6052,9 +6174,25 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.NameHasNoOwner + The name has no owner + + + + Returns the unique connection name of the primary owner of the name - given. If the requested name doesn't have an owner, returns a - org.freedesktop.DBus.Error.NameHasNoOwner error. + given. @@ -6105,6 +6243,23 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.NameHasNoOwner + The name does not exist + + + + Returns the Unix user ID of the process connected to the server. If unable to determine it (for instance, because the process is not on the same machine as the bus daemon), an error is returned. @@ -6158,9 +6313,30 @@ - Returns the Unix process ID of the process connected to the server. If - unable to determine it (for instance, because the process is not on the - same machine as the bus daemon), an error is returned. + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.NameHasNoOwner + The name does not exist + + + org.freedesktop.DBus.Error.UnixProcessIdUnknown + The process ID could not be determined (for instance, + because the process is not on the same machine as the + bus daemon). + + + + + Returns the Unix process ID of the process connected to the server. @@ -6211,6 +6387,23 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.NameHasNoOwner + The name does not exist + + + + @@ -6373,6 +6566,27 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.NameHasNoOwner + The name does not exist + + + org.freedesktop.DBus.Error.AdtAuditDataUnknown + Could not determine audit session data + + + + Returns auditing data used by Solaris ADT, in an unspecified binary format. If you know what this means, please contribute documentation via the D-Bus bug tracking system. @@ -6431,6 +6645,27 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.NameHasNoOwner + The name does not exist + + + org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown + Could not determine security context + + + + Returns the security context used by SELinux, in an unspecified format. If you know what this means, please contribute documentation via the D-Bus bug tracking system. @@ -6468,6 +6703,31 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.LimitsExceeded + The maximum number of match rules have been exceeded + + + org.freedesktop.DBus.Error.MatchRuleInvalid + The match rule string is invalid + + + org.freedesktop.DBus.Error.AccessDenied + The caller does not have permission to eavesdrop + + + + Adds a match rule to match messages going through the message bus (see ). If the bus does not have enough resources the org.freedesktop.DBus.Error.OOM error is returned. @@ -6499,9 +6759,28 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.MatchRuleInvalid + The match rule string is invalid + + + org.freedesktop.DBus.Error.MatchRuleNotFound + The match rule was not found + + + + Removes the first rule that matches (see ). - If the rule is not found the org.freedesktop.DBus.Error.MatchRuleNotFound - error is returned. @@ -6572,6 +6851,27 @@ + Error codes: + + + + + Error + Description + + + + + org.freedesktop.DBus.Error.AccessDenied + Invalid object path, or the caller does not have the permission to eavesdrop + + + org.freedesktop.DBus.Error.MatchRuleInvalid + Invalid match rule + + + + -- 2.12.2