Класс QDBusAbstractInterface

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

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

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

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

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

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

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

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

Классы, генерируемые кодом, также наследуются от 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" будет содержать одну строку Юникод, второй вызов "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().