Класс QDBusAbstractInterface

Класс QDBusAbstractInterface является базовым классом для всех интерфейсов D-Bus в Qt D-Bus binding, позволяющим получить доступ к удалённым интерфейсам Подробнее...

• Список всех членов, включая наследуемые

Открытые функции

• 32 открытых функции, унаследованные от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject
• 2 сигнала, унаследованные от QObject
• 11 статических открытых членов, унаследованные от QObject
• 9 защищённых функций, унаследованные от QObject

Подробное описание

Класс QDBusAbstractInterface является базовым классом для всех интерфейсов D-Bus в Qt D-Bus binding, позволяющим получить доступ к удалённым интерфейсам

Классы сгенерированные кодом также наследуют от QDBusAbstractInterface, все методы, описанные здесь, также справедливы для сгенерированных классов. В дополнение к тем, которые описаны здесь, сгенерированные классы предоставляют функции для удалённых методов, которые позволяют проверять на этапе компиляции корректность параметров и возвращаемых значений, а также соответствие типов свойств и параметров сигналов.

См. также Компилятор QDBus и QDBusInterface.

Документация по функциям-членам

[virtual] QDBusAbstractInterface::~QDBusAbstractInterface()

Освобождает ресурсы данного объекта.

QDBusPendingCall QDBusAbstractInterface::asyncCall(const QString &method, const QVariant &arg1 = QVariant(), const QVariant &arg2 = QVariant(), const QVariant &arg3 = QVariant(), const QVariant &arg4 = QVariant(), const QVariant &arg5 = QVariant(), const QVariant &arg6 = QVariant(), const QVariant &arg7 = QVariant(), const QVariant &arg8 = QVariant())

Вызывает метод method для этого интерфейса и передаёт параметры этой функции методу.

Параметры call передаются удалённой функции через D-Bus в качестве входных аргументов. Возвращаемый объект QDBusPendingCall может быть использован для получения информации о ответе.

Эта функция может использоваться с до 8 параметров, переданных в аргументах arg1, arg2, arg3, arg4, arg5, arg6, arg7 и arg8. Если вам необходимо больше 8 параметров или у вас переменное количество параметров для передачи, используйте asyncCallWithArgumentList().

Она может использоваться следующим образом:

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*)));

Этот пример демонстрирует вызов функций с 0, 1 и 2 параметрами и иллюстрирует различные типы параметров, передаваемых в каждом из них (первый вызов "ProcessWorkUnicode" будет содержать одну строку Unicode, второй вызов "ProcessWork" будет содержать одну строку и один массив байтов).

Эта функция была добавлена в Qt 4.5.

QDBusPendingCall QDBusAbstractInterface::asyncCallWithArgumentList(const QString &method, const QList<QVariant> &args)

Выполняет вызов удалённого метода, указанного параметром method для этого интерфейса, используя args в качестве аргументов. Эта функция возвращает объект QDBusPendingCall, который может использоваться для отслеживания состояния ответа и доступа к его содержимому, как только он придёт.

В нормальных ситуациях, вызовы должны выполняться с помощью asyncCall().

Примечание: Эта функция потокобезопасна.

Эта функция была добавлена в Qt 4.5.

QDBusMessage QDBusAbstractInterface::call(const QString &method, const QVariant &arg1 = QVariant(), const QVariant &arg2 = QVariant(), const QVariant &arg3 = QVariant(), const QVariant &arg4 = QVariant(), const QVariant &arg5 = QVariant(), const QVariant &arg6 = QVariant(), const QVariant &arg7 = QVariant(), const QVariant &arg8 = QVariant())

Вызывает метод method для этого интерфейса и передаёт параметры этой функции методу.

Параметры call передаются удалённой функции через D-Bus в качестве входных аргументов. Результаты вычислений возвращаются в ответе QDBusMessage. Если ответ содержит ошибку, lastError() также будет содержать содержимое сообщения об ошибке.

Эта функция может использоваться с максимум 8 параметрами, переданными в аргументах arg1, arg2, arg3, arg4, arg5, arg6, arg7 и arg8. Если вам нужно больше 8 параметров или у вас переменное число параметров, используйте callWithArgumentList().

Она может быть использована следующим образом:

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());

Этот пример иллюстрирует вызов функции с 0, 1 и 2 параметрами и демонстрирует различные типы параметров, передаваемых в каждом случае (первый вызов "ProcessWorkUnicode" будет содержать одну строку Юникод, второй вызов "ProcessWork" будет содержать одну строку и один массив байтов).

QDBusMessage QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &method, const QVariant &arg1 = QVariant(), const QVariant &arg2 = QVariant(), const QVariant &arg3 = QVariant(), const QVariant &arg4 = QVariant(), const QVariant &arg5 = QVariant(), const QVariant &arg6 = QVariant(), const QVariant &arg7 = QVariant(), const QVariant &arg8 = QVariant())

Это перегруженная функция.

Вызывает метод method на этом интерфейсе и передаёт параметры этой функции методу. Если mode равен NoWaitForReply, функция вернётся сразу после выполнения вызова, не ожидая ответа от удалённого метода. В противном случае, mode указывает, нужно ли активировать цикл обработки событий Qt при ожидании ответа.

Эта функция может использоваться с максимум 8 параметрами, переданными в аргументах arg1, arg2, arg3, arg4, arg5, arg6, arg7 и arg8. Если вам нужно больше 8 параметров или у вас переменное число параметров, используйте callWithArgumentList().

Если эта функция повторно входит в цикл обработки событий Qt, чтобы дождаться ответа, она исключит пользовательский ввод. Во время ожидания она может отправлять сигналы и другие вызовы методов вашему приложению. Поэтому оно должно быть готово к повторному входу при каждом вызове с call().

QDBusMessage QDBusAbstractInterface::callWithArgumentList(QDBus::CallMode mode, const QString &method, const QList<QVariant> &args)

Вызывает удалённый метод, указанный параметром method, на этом интерфейсе, используя args в качестве аргументов. Эта функция возвращает сообщение, полученное в качестве ответа, которое может быть обычным ответом QDBusMessage::ReplyMessage (указывает успех) или сообщением об ошибке QDBusMessage::ErrorMessage (если вызов не удался). Параметр mode определяет, как должен быть размещён этот вызов.

В случае успеха, lastError() будет очищено; в противном случае, оно будет содержать ошибку, возникшую при этом вызове.

Обычно вы должны размещать вызовы с помощью call().

Предупреждение: Если вы используете UseEventLoop, ваш код должен быть готов к повторному входу: другие вызовы методов и сигналы могут быть доставлены до возвращения этой функции, а также другие очереди Qt сигналов и событий.

Примечание: Эта функция безопасна для потоков.

bool QDBusAbstractInterface::callWithCallback(const QString &method, const QList<QVariant> &args, QObject *receiver, const char *returnMethod, const char *errorMethod)

Вызывает удалённый метод, указанный параметром method, на этом интерфейсе, используя args в качестве аргументов. Эта функция возвращается сразу после помещения вызова в очередь. Ответ от удалённой функции доставляется в returnMethod объекта receiver. Если произошла ошибка, вызывается errorMethod объекта receiver.

Эта функция возвращает true, если размещение в очереди успешно. Она не указывает, что выполненный вызов успешен. Если произошла ошибка, вызывается errorMethod. Если размещение в очередь не удалось, эта функция возвращает false и никакой слот не будет вызван.

returnMethod должен иметь в качестве параметров типы, возвращаемые вызовом функции. По желанию, он может иметь параметр QDBusMessage в качестве последнего или единственного параметра. errorMethod должен иметь QDBusError в качестве единственного параметра.

Эта функция была добавлена в Qt 4.3.

См. также QDBusError и QDBusMessage.

bool QDBusAbstractInterface::callWithCallback(const QString &method, const QList<QVariant> &args, QObject *receiver, const char *slot)

Это перегруженная функция.

Эта функция устарела. Пожалуйста, используйте перегруженную версию.

Вызывает удалённый метод, указанный параметром method, на этом интерфейсе, используя args в качестве аргументов. Эта функция возвращается сразу после помещения вызова в очередь. Ответ от удалённой функции или любые ошибки, отправленные ею, доставляются в слот slot объекта receiver.

Эта функция возвращает true, если размещение в очереди успешно: это не указывает, что вызов успешен. Если произошла ошибка, слот будет вызван с сообщением об ошибке. lastError() не будет установлено в таких обстоятельствах.

См. также QDBusError и QDBusMessage.

QDBusConnection QDBusAbstractInterface::connection() const

Возвращает подключение, с которым связан этот интерфейс.

QString QDBusAbstractInterface::interface() const

Возвращает имя этого интерфейса.

bool QDBusAbstractInterface::isValid() const

Возвращает true, если это действительная ссылка на удалённый объект. Возвращает false, если при создании этого интерфейса произошла ошибка (например, если удалённое приложение не существует).

Примечание: при работе с удалёнными объектами, не всегда возможно определить, существует ли он при создании QDBusInterface.

QDBusError QDBusAbstractInterface::lastError() const

Возвращает ошибку, возникшую при последнем выполнении операции, или ошибку, не являющуюся ошибкой, если последняя операция не привела к ошибке.

QString QDBusAbstractInterface::path() const

Возвращает путь объекта, с которым связан этот интерфейс.

QString QDBusAbstractInterface::service() const

Возвращает имя службы, с которой связан этот интерфейс.

void QDBusAbstractInterface::setTimeout(int timeout)

Устанавливает тайм-аут в миллисекундах для всех будущих вызовов DBus в timeout. -1 означает стандартный тайм-аут DBus (обычно 25 секунд).

Эта функция была добавлена в Qt 4.8.

См. также timeout().

int QDBusAbstractInterface::timeout() const

Возвращает текущее значение тайм-аута в миллисекундах. -1 означает стандартный тайм-аут DBus (обычно 25 секунд).

Эта функция была добавлена в Qt 4.8.

См. также setTimeout().