class QDBusError

The QDBusError class represents an error received from the D-Bus bus or from remote applications found in the bus. More

Synopsis

Methods

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

When dealing with the D-Bus bus service or with remote applications over D-Bus, a number of error conditions can happen. This error conditions are sometimes signalled by a returned error value or by a QDBusError .

C++ and Java exceptions are a valid analogy for D-Bus errors: instead of returning normally with a return value, remote applications and the bus may decide to throw an error condition. However, the Qt D-Bus implementation does not use the C++ exception-throwing mechanism, so you will receive QDBusErrors in the return reply (see error() ).

QDBusError objects are used to inspect the error name and message as received from the bus and remote applications. You should not create such objects yourself to signal error conditions when called from D-Bus: instead, use createError() and send() .

See also

send() QDBusMessage QDBusReply

class ErrorType

In order to facilitate verification of the most common D-Bus errors generated by the D-Bus implementation and by the bus daemon itself, QDBusError can be compared to a set of pre-defined values:

Constant

Description

QDBusError.NoError

QDBusError is invalid (i.e., the call succeeded)

QDBusError.Other

QDBusError contains an error that is not one of the well-known ones

QDBusError.Failed

The call failed (org.freedesktop.DBus.Error.Failed)

QDBusError.NoMemory

Out of memory (org.freedesktop.DBus.Error.NoMemory)

QDBusError.ServiceUnknown

The called service is not known (org.freedesktop.DBus.Error.ServiceUnknown)

QDBusError.NoReply

The called method did not reply within the specified timeout (org.freedesktop.DBus.Error.NoReply)

QDBusError.BadAddress

The address given is not valid (org.freedesktop.DBus.Error.BadAddress)

QDBusError.NotSupported

The call/operation is not supported (org.freedesktop.DBus.Error.NotSupported)

QDBusError.LimitsExceeded

The limits allocated to this process/call/connection exceeded the pre-defined values (org.freedesktop.DBus.Error.LimitsExceeded)

QDBusError.AccessDenied

The call/operation tried to access a resource it isn’t allowed to (org.freedesktop.DBus.Error.AccessDenied)

QDBusError.NoServer

Documentation doesn’t say what this is for (org.freedesktop.DBus.Error.NoServer)

QDBusError.Timeout

Documentation doesn’t say what this is for or how it’s used (org.freedesktop.DBus.Error.Timeout)

QDBusError.NoNetwork

Documentation doesn’t say what this is for (org.freedesktop.DBus.Error.NoNetwork)

QDBusError.AddressInUse

QDBusServer tried to bind to an address that is already in use (org.freedesktop.DBus.Error.AddressInUse)

QDBusError.Disconnected

The call/process/message was sent after QDBusConnection disconnected (org.freedesktop.DBus.Error.Disconnected)

QDBusError.InvalidArgs

The arguments passed to this call/operation are not valid (org.freedesktop.DBus.Error.InvalidArgs)

QDBusError.UnknownMethod

The method called was not found in this object/interface with the given parameters (org.freedesktop.DBus.Error.UnknownMethod)

QDBusError.TimedOut

Documentation doesn’t say… (org.freedesktop.DBus.Error.TimedOut)

QDBusError.InvalidSignature

The type signature is not valid or compatible (org.freedesktop.DBus.Error.InvalidSignature)

QDBusError.UnknownInterface

The interface is not known in this object (org.freedesktop.DBus.Error.UnknownInterface)

QDBusError.UnknownObject

The object path points to an object that does not exist (org.freedesktop.DBus.Error.UnknownObject)

QDBusError.UnknownProperty

The property does not exist in this interface (org.freedesktop.DBus.Error.UnknownProperty)

QDBusError.PropertyReadOnly

The property set failed because the property is read-only (org.freedesktop.DBus.Error.PropertyReadOnly)

QDBusError.InternalError

An internal error occurred

QDBusError.InvalidObjectPath

The object path provided is invalid.

QDBusError.InvalidService

The service requested is invalid.

QDBusError.InvalidMember

The member is invalid.

QDBusError.InvalidInterface

The interface is invalid.

__init__()
__init__(other)
Parameters:

otherQDBusError

__init__(msg)
Parameters:

msgQDBusMessage

__init__(error, message)
Parameters:
static errorString(error)
Parameters:

errorErrorType

Return type:

str

Returns the error name associated with error condition error.

isValid()
Return type:

bool

Returns true if this is a valid error condition (i.e., if there was an error), otherwise false.

message()
Return type:

str

Returns the message that the callee associated with this error. Error messages are implementation defined and usually contain a human-readable error code, though this does not mean it is suitable for your end-users.

name()
Return type:

str

Returns this error’s name. Error names are similar to D-Bus Interface names, like org.freedesktop.DBus.InvalidArgs.

See also

type()

swap(other)
Parameters:

otherQDBusError

Swaps this QDBusError instance with other.

type()
Return type:

ErrorType

Returns this error’s ErrorType .

See also

ErrorType