QDBusContext Class

class MyObject: public QObject,
                protected QDBusContext
{
    Q_OBJECT

    QDBusConnection conn;
    QDBusMessage msg;

    //...

protected slots:
    void process();
public slots:
    void methodWithError();
    QString methodWithDelayedReply();
};

void MyObject::methodWithError()
{
    sendErrorReply(QDBusError::NotSupported,
                   "The method call 'methodWithError()' is not supported");
}

QString MyObject::methodWithDelayedReply()
{
    conn = connection();
    msg = message();
    setDelayedReply(true);
    QMetaObject::invokeMethod(this, &MyObject::process, Qt::QueuedConnection);
    return QString();
}

メンバ関数のドキュメント

QDBusContext::QDBusContext()

空の QDBusContext を生成します。

[noexcept] QDBusContext::~QDBusContext()

空のデストラクタ。

bool QDBusContext::calledFromDBus() const

D-Bus 呼び出しを処理中の場合は、true を返します。この関数がtrue を返した場合、このクラスの残りの関数を利用できます。

この関数が `false ` を返しているときにこれらの関数にアクセスすると、挙動は未定義となり、クラッシュの原因となる可能性があります。

QDBusConnection QDBusContext::connection() const

この呼び出しを受信した接続を返します。

bool QDBusContext::isDelayedReply() const

この呼び出しで応答が遅延する場合、true を返します。

setDelayedReply()も参照してください 。

const QDBusMessage &QDBusContext::message() const

この呼び出しを生成したメッセージを返します。

void QDBusContext::sendErrorReply(const QString &name, const QString &msg = QString()) const

呼び出し元に対して、エラーname を応答として返します。オプションのmsg パラメータは、失敗の原因を説明する人間が読みやすいテキストです。

エラーが送信された場合、呼び出し元からの戻り値および呼び出されたスロットからの出力パラメータは、Qt D-Bus によって無視されます。

void QDBusContext::sendErrorReply(QDBusError::ErrorType type, const QString &msg = QString()) const

呼び出し元に対して、エラーtype を応答として返します。オプションのmsg パラメータは、失敗の原因を説明する人間が読みやすいテキストです。

エラーが送信された場合、呼び出し元からの戻り値および呼び出されたスロットからの出力パラメータは、Qt D-Bus によって無視されます。

void QDBusContext::setDelayedReply(bool enable) const

この呼び出しで応答を遅延させるかどうかを設定します。

enable がfalseの場合、Qt D-Bus は、必要に応じて、呼び出されたスロットが返り値を返した直後に、呼び出し元への返信を自動的に生成します。

enable が true の場合、Qt D-Bus は自動応答を生成しません。また、スロットからの戻り値や出力パラメータも無視します。その代わりに、呼び出されたオブジェクトが受信メッセージを保存し、後で応答またはエラーを送信する責任を負います。

返信の送信に失敗すると、D-Bus によって自動タイムアウトエラーが発生します。

isDelayedReply()も参照してください 。