QDBusConnection Class

メンバ関数の説明

[explicit] QDBusConnection::QDBusConnection(const QString &name)

名前name を持つ接続にアタッチされた QDBusConnection オブジェクトを作成します。

これは接続をオープンしません。接続を開くには、connectToBus() を呼び出す必要があります。

QDBusConnection::QDBusConnection(const QDBusConnection &other)

other 接続のコピーを作成します。

[noexcept] QDBusConnection::~QDBusConnection()

このオブジェクトを破棄します。接続を閉じるには、disconnectFromBus() を呼び出す必要があります。

QDBusPendingCall QDBusConnection::asyncCall(const QDBusMessage &message, int timeout = -1) const

この接続を介してmessage を送信し、すぐに戻ります。この関数は、メソッド呼び出しにのみ適しています。この関数は、QDBusPendingCall 型のオブジェクトを返します。このオブジェクトは、応答のステータスを追跡するために使用できます。

timeout ミリ秒以内に応答がない場合、呼び出しの終了を示す自動エラーが配信されます。デフォルトのtimeout は-1であり、プロセス間通信に適した実装定義値（通常、25秒）に置き換え られる。このタイムアウトは、QDBusPendingCall::waitForFinished() での待機の上限でもある。

より使いやすい呼び出しの配置方法については、QDBusInterface::asyncCall() 関数を参照してください。

QString QDBusConnection::baseService() const

このQDBusConnection オブジェクトが接続されている場合は、この接続の一意の接続名を返し、そうでない場合は空のQString を返します。

一意の接続名は、接続時にD-Busサーバー・デーモンによって割り当てられる":x.xxx"(xは10進数)という形式の文字列です。これは、バス内でこのクライアントを一意に識別する。

この関数は、ピアツーピア接続の場合は空のQString を返します。

QDBusMessage QDBusConnection::call(const QDBusMessage &message, QDBus::CallMode mode = QDBus::Block, int timeout = -1) const

この接続を介してmessage を送信し、最大でtimeout ミリ秒の間ブロックして応答を待ちます。この関数はメソッド呼び出しにのみ適している。この関数の返り値はリプライ・メッセージで、QDBusMessage::ReplyMessage またはQDBusMessage::ErrorMessage のいずれかの型である。

timeout ミリ秒以内に返信がない場合、呼び出しが終了したことを示す自動的なエ ラーが送られる。デフォルトのtimeout は-1であり、プロセス間通信に適した実装定義値（通常は25秒）に置き換えられる。

よりフレンドリーな呼び出し方法については、QDBusInterface::call() 関数を参照のこと。

bool QDBusConnection::callWithCallback(const QDBusMessage &message, QObject *receiver, const char *returnMethod, const char *errorMethod, int timeout = -1) const

この接続を介してmessage を送信し、すぐに戻る。応答を受信すると、receiver オブジェクトのメソッドreturnMethod が呼び出される。エラーが発生した場合は、代わりにerrorMethod 。

timeout ミリ秒以内に返信を受け取らなかった場合、呼び出しの終了を示す自動エ ラーが配信される。デフォルトのtimeout は-1であり、プロセス間通信に適した実装定義の値（一般的には25秒）に置き換えられる。

この関数はメソッド呼び出しにのみ適している。パラメータ・タイプが一致し、エラーが発生しない限り、このスロットは応答とともに正確に1回呼び出されることが保証されています。

メッセージが送信された場合はtrue を返し、メッセージが送信できなかった場合は false を返します。

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, QObject *receiver, const char *slot)

service,path,interface,name パラメータで指定されたシグナルを、オブジェクトreceiver のスロットslot に接続する。引数service とpath は空でもよく、リモート・アプリケーションから (interface,name) ペアの任意のシグナルへの接続を示します。

接続に成功した場合はtrue を返す。

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject *receiver, const char *slot)

これはオーバーロードされた関数です。

オブジェクトreceiver のスロットslot にシグナルを接続します。以前のconnect()オーバーロードとは異なり、この関数では、signature 変数を使用して、接続するパラメータのシグネチャを指定することができます。この関数は、このシグネチャがslot で指定されたスロットに配信できるかどうかを確認し、そうでない場合は false を返します。

接続に成功した場合はtrue を返す。

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject *receiver, const char *slot)

これはオーバーロードされた関数です。

オブジェクトreceiver のスロットslot にシグナルを接続します。以前のconnect()オーバーロードとは異なり、この関数では、signature 変数を使用して、接続するパラメータのシグネチャを指定することができる。この関数は、このシグネチャがslot で指定されたスロットに配信できるかどうかを確認し、そうでない場合は false を返します。

argumentMatch パラメータには、マッチする文字列パラメータが順番に列挙されている。空の文字列をマッチさせるには、空だがNULLではないQString （すなわち、QString （""））を渡す必要があることに注意。NULLQString は、その位置でのマッチングをスキップする。

接続に成功した場合はtrue を返します。

[static] QDBusConnection QDBusConnection::connectToBus(QDBusConnection::BusType type, const QString &name)

type 型の接続を既知のバスの1つに開き、接続名name をそれに関連付ける。その接続に関連付けられたQDBusConnection オブジェクトを返します。

[static] QDBusConnection QDBusConnection::connectToBus(const QString &address, const QString &name)

アドレスaddress のプライベート・バスへの接続を開き、それに接続名name を関連付けます。その接続に関連付けられたQDBusConnection オブジェクトを返します。

[static] QDBusConnection QDBusConnection::connectToPeer(const QString &address, const QString &name)

アドレスaddress でピアツーピア接続を開き、接続名name に関連付けます。その接続に関連付けられたQDBusConnection オブジェクトを返します。

QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities() const

バス・サーバまたはピアとネゴシエートされた、この接続の能力を返します。このQDBusConnection が接続されていない場合、この関数は能力を返さない。

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, QObject *receiver, const char *slot)

オブジェクトreceiver のスロットslot から、パラメータservice 、path 、interface 、name で指定されたシグナルを切断する。引数は、connect() 関数に渡されたものと同じでなければならない。

切断が成功した場合、true を返す。

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject *receiver, const char *slot)

これはオーバーロードされた関数である。

オブジェクトreceiver のスロットslot から、パラメータservice,path,interface,name,signature で指定されたシグナルを切断する。引数は、connect() 関数に渡されたものと同じでなければならない。

切断が成功した場合、true を返す。

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject *receiver, const char *slot)

これはオーバーロードされた関数である。

オブジェクトreceiver のスロットslot から、パラメータservice,path,interface,name,argumentMatch,signature で指定されたシグナルを切断する。引数はconnect() 関数に渡されたものと同じでなければならない。

切断が成功した場合、true を返す。

[static] void QDBusConnection::disconnectFromBus(const QString &name)

名前name のバス接続を閉じます。

同じ接続に関連付けられているQDBusConnection オブジェクトがまだ存在する場合、すべての参照が削除されるまで接続は閉じられないことに注意してください。ただし、QDBusConnection コンストラクタを使用して、それ以上参照を作成することはできません。

[static] void QDBusConnection::disconnectFromPeer(const QString &name)

名前name のピア接続を閉じます。

同じ接続に関連付けられているQDBusConnection オブジェクトがまだ存在する場合、すべての参照が削除されるまで接続は閉じられないことに注意してください。ただし、QDBusConnection コンストラクタを使用して、それ以上参照を作成することはできません。

QDBusConnectionInterface *QDBusConnection::interface() const

この接続の D-Bus サーバー・インタフェースを表すQDBusConnectionInterface オブジェクトを返します。

bool QDBusConnection::isConnected() const

このQDBusConnection オブジェクトが接続されている場合は、true を返します。

QDBusError QDBusConnection::lastError() const

この接続で最後に発生したエラーを返します。

この関数は低レベル・コード用に用意されています。QDBusInterface::call() を使用している場合、エラー・コードはその返り値によって報告されます。

QDBusInterface およびQDBusMessageも参照のこと 。

[static] QByteArray QDBusConnection::localMachineId()

D-Bus システムが知っているローカル・マシン ID を返します。D-Busを実行する各ノードまたはホストには、ファイルシステムなどのリソースを共有している場合に、他のホストと区別するために使用できる一意の識別子があります。

ローカル・マシンIDは、システムのブート全体にわたって永続的であることは保証されないので、この識別子を（ファイルシステムのような）永続ストレージに保存すべきではないことに注意してください。この識別子は、このブート・セッションの有効期間中だけ一定であることが保証されています。

QString QDBusConnection::name() const

connectToBus() の name パラメータとして指定された、この接続の接続名を返します。

接続名は、バスへの実際の基礎となる接続を一意に識別するために使用できます。単一の接続から作成されたコピーは、常に暗黙のうちに基礎となる接続を共有し、したがって同じ接続名を持つことになります。

逆に、異なる接続名を持つ2つの接続は、常に異なるバスに接続されるか、そのバス上で異なる一意名（baseService （）によって返される）を持つことになる。

connectToBus() およびdisconnectFromBus()も参照のこと 。

QObject *QDBusConnection::objectRegisteredAt(const QString &path) const

path で指定されたオブジェクト・パスにregisterObject() で登録されたオブジェクトを返す。

bool QDBusConnection::registerObject(const QString &path, QObject *object, QDBusConnection::RegisterOptions options = ExportAdaptors)

パスpath にオブジェクトobject を登録し、登録に成功した場合はtrue を返す。options パラメータは、オブジェクトobject のどの程度を D-Bus 経由で公開するかを指定する。

パスpath にすでにオブジェクトが登録されている場合、この関数は false を返します。unregisterObject() を使用して、まず登録を解除してください。

ExportChildObjects フラグは、登録されたオブジェクトのパスと子のQObject::objectName に基づいて、D-Bus 上の子オブジェクトをエクスポートします。したがって、子オブジェクトがオブジェクト名を持っていることが重要です。

ExportChildObjects で登録されたオブジェクトの子オブジェクトとしてオブジェクトを登録することはできません。

bool QDBusConnection::registerObject(const QString &path, const QString &interface, QObject *object, QDBusConnection::RegisterOptions options = ExportAdaptors)

これはオーバーロードされた関数です。

パスpath にあるオブジェクトobject をインターフェース名interface で登録し、登録に成功した場合はtrue を返します。options パラメータは、オブジェクトobject のどの程度が D-Bus を通じて公開されるかを指定します。

この関数は既存のオブジェクトを置き換えることはありません。パスpath にすでにオブジェクトが登録されている場合、この関数は false を返します。unregisterObject() を使用して、まず登録を解除してください。

ExportChildObjects フラグは、登録されたオブジェクトのパスと子のQObject::objectName に基づいて、D-Bus 上の子オブジェクトをエクスポートします。したがって、子オブジェクトがオブジェクト名を持っていることが重要です。

ExportChildObjects で登録されたオブジェクトの子オブジェクトとしてオブジェクトを登録することはできません。

bool QDBusConnection::registerService(const QString &serviceName)

D-Bus サーバーでserviceName の登録を試み、登録に成功した場合はtrue を返します。その名前が他のアプリケーションによって既に登録されている場合、登録は失敗します。

unregisterService() およびQDBusConnectionInterface::registerService()も参照 。

bool QDBusConnection::send(const QDBusMessage &message) const

応答を待たずに、この接続を介してmessage を送信する。これは、エラー、シグナル、返り値、および返り値が不要な呼び出しに適しています。

メッセージが正常にキューイングされた場合はtrue を返し、そうでない場合は false を返します。

[static] QDBusConnection QDBusConnection::sessionBus()

セッション・バスでオープンされたQDBusConnection オブジェクトを返します。この関数が返すオブジェクト参照は、アプリケーションが終了するまで有効で、終了すると接続は閉じられ、オブジェクトは削除されます。

[noexcept] void QDBusConnection::swap(QDBusConnection &other)

このQDBusConnection インスタンスをother と交換します。

[static] QDBusConnection QDBusConnection::systemBus()

システム・バスでオープンされたQDBusConnection オブジェクトを返します。この関数によって返されるオブジェクト参照は、QCoreApplication のデストラクタが実行され、接続が閉じられオブジェクトが削除されるまで有効です。

void QDBusConnection::unregisterObject(const QString &path, QDBusConnection::UnregisterMode mode = UnregisterNode)

path で指定されたオブジェクト・パスにregisterObject() で登録されたオブジェクトの登録を解除し、mode がQDBusConnection::UnregisterTree の場合、そのサブ・オブジェクトもすべて解除します。

registerObject() で登録されていないオブジェクトの登録解除はできないことに注意。

bool QDBusConnection::unregisterService(const QString &serviceName)

以前にregisterService() で登録されたサービスserviceName の登録を解除し、成功した場合はtrue を返す。

registerService() およびQDBusConnectionInterface::unregisterService()も参照して ください。

QDBusConnection &QDBusConnection::operator=(const QDBusConnection &other)

このオブジェクト内に接続other のコピーを作成します。コピーの前にこのオブジェクトが参照していた接続は、自発的に切断されないことに注意。

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