QDBusAbstractInterface露

PyQt5.QtDBus.QDBusAbstractInterface

Inherits from QObject.

Inherited by QDBusConnectionInterface, QDBusInterface.

Description露

The QDBusAbstractInterface class is the base class for all D-Bus interfaces in the Qt D-Bus binding, allowing access to remote interfaces.

Generated-code classes also derive from QDBusAbstractInterface, all methods described here are also valid for generated-code classes. In addition to those described here, generated-code classes provide member functions for the remote methods, which allow for compile-time checking of the correct parameters and return values, as well as property type-matching and signal parameter-matching.

Methods露

__init__(str, str, str, QDBusConnection, QObject): This is the constructor called from static classes derived from QDBusAbstractInterface (i.e., those generated by dbusxml2cpp).

asyncCall(str, arg1: Any = None, arg2: Any = None, arg3: Any = None, arg4: Any = None, arg5: Any = None, arg6: Any = None, arg7: Any = None, arg8: Any = None) → QDBusPendingCall

Calls the method method on this interface and passes the parameters to this function to the method.

The parameters to call are passed on to the remote function via D-Bus as input arguments. The returned QDBusPendingCall object can be used to find out information about the reply.

This function can be used with up to 8 parameters, passed in arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7 and arg8. If you need more than 8 parameters or if you have a variable number of parameters to be passed, use asyncCallWithArgumentList().

It can be used the following way:

# QString value = retrieveValue();
# QDBusPendingCall pcall = interface->asyncCall(QLatin1String("Process"), value);

# QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(pcall, this);

# QObject::connect(watcher, SIGNAL(finished(QDBusPendingCallWatcher*)),
#                  this, SLOT(callFinishedSlot(QDBusPendingCallWatcher*)));

This example illustrates function calling with 0, 1 and 2 parameters and illustrates different parameter types passed in each (the first call to "ProcessWorkUnicode" will contain one Unicode string, the second call to "ProcessWork" will contain one string and one byte array).

asyncCallWithArgumentList(str, Iterable[Any]) → QDBusPendingCall

Places a call to the remote method specified by method on this interface, using args as arguments. This function returns a QDBusPendingCall object that can be used to track the status of the reply and access its contents once it has arrived.

Normally, you should place calls using asyncCall().

call(str, arg1: Any = None, arg2: Any = None, arg3: Any = None, arg4: Any = None, arg5: Any = None, arg6: Any = None, arg7: Any = None, arg8: Any = None) → QDBusMessage

Calls the method method on this interface and passes the parameters to this function to the method.

The parameters to call are passed on to the remote function via D-Bus as input arguments. Output arguments are returned in the QDBusMessage reply. If the reply is an error reply, lastError() will also be set to the contents of the error message.

This function can be used with up to 8 parameters, passed in arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7 and arg8. If you need more than 8 parameters or if you have a variable number of parameters to be passed, use callWithArgumentList().

It can be used the following way:

# QString value = retrieveValue();
# QDBusMessage reply;

# QDBusReply<int> api = interface->call(QLatin1String("GetAPIVersion"));
# if (api >= 14)
#   reply = interface->call(QLatin1String("ProcessWorkUnicode"), value);
# else
#   reply = interface->call(QLatin1String("ProcessWork"), QLatin1String("UTF-8"), value.toUtf8());

This example illustrates function calling with 0, 1 and 2 parameters and illustrates different parameter types passed in each (the first call to "ProcessWorkUnicode" will contain one Unicode string, the second call to "ProcessWork" will contain one string and one byte array).

call(CallMode, str, arg1: Any = None, arg2: Any = None, arg3: Any = None, arg4: Any = None, arg5: Any = None, arg6: Any = None, arg7: Any = None, arg8: Any = None) → QDBusMessage

This is an overloaded function.

Calls the method method on this interface and passes the parameters to this function to the method. If mode is NoWaitForReply, then this function will return immediately after placing the call, without waiting for a reply from the remote method. Otherwise, mode indicates whether this function should activate the Qt Event Loop while waiting for the reply to arrive.

This function can be used with up to 8 parameters, passed in arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7 and arg8. If you need more than 8 parameters or if you have a variable number of parameters to be passed, use callWithArgumentList().

If this function reenters the Qt event loop in order to wait for the reply, it will exclude user input. During the wait, it may deliver signals and other method calls to your application. Therefore, it must be prepared to handle a reentrancy whenever a call is placed with call().

callWithArgumentList(CallMode, str, Iterable[Any]) → QDBusMessage

Places a call to the remote method specified by method on this interface, using args as arguments. This function returns the message that was received as a reply, which can be a normal ReplyMessage (indicating success) or ErrorMessage (if the call failed). The mode parameter specifies how this call should be placed.

If the call succeeds, lastError() will be cleared; otherwise, it will contain the error this call produced.

Normally, you should place calls using call().

Warning: If you use UseEventLoop, your code must be prepared to deal with any reentrancy: other method calls and signals may be delivered before this function returns, as well as other Qt queued signals and events.

callWithCallback(str, Iterable[Any], PYQT_SLOT) → bool: TODO

callWithCallback(str, Iterable[Any], PYQT_SLOT, PYQT_SLOT) → bool: TODO

connection() → QDBusConnection: Returns the connection this interface is associated with.

connectNotify(QMetaMethod): TODO

disconnectNotify(QMetaMethod): TODO

interface() → str: Returns the name of this interface.

isValid() → bool

Returns true if this is a valid reference to a remote object. It returns false if there was an error during the creation of this interface (for instance, if the remote application does not exist).

Note: when dealing with remote objects, it is not always possible to determine if it exists when creating a QDBusInterface.

lastError() → QDBusError: Returns the error the last operation produced, or an invalid error if the last operation did not produce an error.

path() → str: Returns the object path that this interface is associated with.

service() → str: Returns the name of the service this interface is associated with.

setTimeout(int): Sets the timeout in milliseconds for all future DBus calls to timeout. -1 means the default DBus timeout (usually 25 seconds).

See also

timeout().

timeout() → int: Returns the current value of the timeout in milliseconds. -1 means the default DBus timeout (usually 25 seconds).

See also

setTimeout().