QLocalServer Class

メンバ関数ドキュメント

[explicit] QLocalServer::QLocalServer(QObject *parent = nullptr)

与えられたparent で新しいローカルソケットサーバを作成する。

listen()も参照のこと 。

[virtual noexcept] QLocalServer::~QLocalServer()

QLocalServer オブジェクトを破棄する。サーバーが接続をリッスンしている場合、自動的にクローズされます。

まだ接続されているクライアント QLocalSocket は、サーバーが削除される前に切断するか、再接続する必要があります。

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

[protected, since 6.8] void QLocalServer::addPendingConnection(QLocalSocket *socket)

この関数はQLocalServer::incomingConnection() から呼び出され、保留中の着信接続リストにsocket を追加する。

この関数は Qt 6.8 で導入されました。

incomingConnection() およびnewConnection()も参照してください 。

void QLocalServer::close()

着信接続のリッスンを停止する。既存の接続は影響を受けないが、新しい接続は拒否される。

isListening() およびlisten()も参照のこと 。

QString QLocalServer::errorString() const

serverError() が報告した現在のエラーに対応する、人間が読めるメッセージを返す。適切な文字列がない場合は、空の文字列が返されます。

serverError()も参照 。

QString QLocalServer::fullServerName() const

サーバがリッスンしているフルパスを返します。

注意: これはプラットフォーム固有のものです。

listen() およびserverName()も参照 。

[virtual] bool QLocalServer::hasPendingConnections() const

サーバーに保留中の接続がある場合はtrue を返し、そうでない場合はfalse を返す。

nextPendingConnection() およびsetMaxPendingConnections()も参照のこと 。

[virtual protected] void QLocalServer::incomingConnection(quintptr socketDescriptor)

この仮想関数は、新しい接続が利用可能になるとQLocalServer から呼び出される。socketDescriptor は、受け付けた接続のネイティブソケットディスクリプタである。

基本実装はQLocalSocket を生成し、ソケットディスクリプタを設定し、保留中の接続の内部リストにQLocalSocket を格納する。最後にnewConnection() が発行される。

この関数を再実装して、接続が可能になったときのサーバーの動作を変更する。

newConnection(),nextPendingConnection(),QLocalSocket::setSocketDescriptor()も参照のこと 。

bool QLocalServer::isListening() const

サーバーが着信コネクションをリッスンしている場合はtrue を返し、そうでない場合は false を返す。

listen() およびclose()も参照 。

bool QLocalServer::listen(const QString &name)

name で着信コネクションをリッスンするようにサーバに指示する。サーバが現在リッスン中の場合は false を返す。成功すればtrueを返し、そうでなければfalseを返します。

name には単一の名前を指定でき、 がプラットフォーム固有の正しいパスを決定します。() は listen に渡された名前を返します。QLocalServer serverName

通常は "foo "のような名前を渡しますが、Unixでは"/tmp/foo "のようなパス、Windowsでは"˶.˶pipefoo "のようなパイプパスにすることもできます。

serverName()、isListening()、close()も参照のこと 。

bool QLocalServer::listen(qintptr socketDescriptor)

socketDescriptor で着信接続をリッスンするようサーバに指示する。このプロパティは、サーバが現在リッスン中であればfalse を返す。成功するとtrue を返し、失敗するとfalse を返す。ソケットは新しい接続を受け付ける準備ができていなければならない。ソケットはノンブロッキングモードに設定される。

serverName QString(),fullServerName() は、このオプションがプラットフォームでサポートされている場合、名前の文字列を返すことができる。

isListening() およびclose()も参照のこと 。

[since 6.3] int QLocalServer::listenBacklogSize() const

受付中の接続のバックログキューサイズを返します。

この関数は Qt 6.3 で導入されました。

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

int QLocalServer::maxPendingConnections() const

保留中の接続の最大数を返します。デフォルトは 30 である。

setMaxPendingConnections() およびhasPendingConnections()も参照 。

[signal] void QLocalServer::newConnection()

このシグナルは、新しい接続が利用可能になるたびに発せられる。

hasPendingConnections() およびnextPendingConnection()も参照のこと 。

[virtual] QLocalSocket *QLocalServer::nextPendingConnection()

次の保留中の接続を接続済みのQLocalSocket オブジェクトとして返す。

ソケットはサーバの子として生成されるので、QLocalServer オブジェクトが破棄されると自動的に削除される。しかし、メモリの無駄遣いを避けるために、そのオブジェクトを使い終わったら明示的に削除することをお勧めします。

nullptr 保留中の接続がないときにこの関数がコールされた場合は、この関数が返されます。

hasPendingConnections()、newConnection()、incomingConnection()も参照 。

[static] bool QLocalServer::removeServer(const QString &name)

listen() の呼び出しが失敗する原因となる可能性のあるサーバ・インスタンスを削除し、 成功した場合はtrue を返し、失敗した場合はfalse を返す。この関数は、以前のサーバー・インスタンスがクリーンアップされていない場合に、クラッシュから回復するためのものである。

Windowsでは、この関数は何もしない。Unixでは、name で指定されたソケットファイルを削除する。

QAbstractSocket::SocketError QLocalServer::serverError() const

最後に発生したエラーの種類、またはNoError を返す。

errorString()も参照のこと 。

QString QLocalServer::serverName() const

サーバが接続をリッスンしている場合はサーバ名を返し、そうでない場合は QString() を返します。

listen() およびfullServerName()も参照ください 。

[since 6.3] void QLocalServer::setListenBacklogSize(int size)

受け付ける接続のバックログキューサイズをsize に設定する。 オペレーティングシステムはこの値を小さくしたり、無視したりするかもしれない。デフォルトでは、キュー・サイズは 50 である。

この関数は Qt 6.3 で導入されました。

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

void QLocalServer::setMaxPendingConnections(int numConnections)

numConnections QLocalServer は、 () が呼び出される前に、 を超える着信コネクションを受け付けない。nextPendingConnection numConnections

注意:QLocalServer が保留中の最大接続数に達した後、新しい接続の受け付けを停止しても、 オペレーティングシステムは、接続中であることをクライアントに知らせるため、 接続をキューに残しておくことがある。

maxPendingConnections() およびhasPendingConnections()も参照の こと。

qintptr QLocalServer::socketDescriptor() const

サーバが着信命令をリッスンするために使用するネイティブソケットディスクリプタを返す。

ディスクリプタの型はプラットフォームに依存する：

• Windows の場合、戻り値はWinsock 2 ソケットハンドルである。
• INTEGRITY の場合、戻り値はQTcpServer ソケットディスクリプタであり、型はsocketDescriptor で定義される。
• 他の全ての UNIX 系オペレーティングシステムでは、型はリスニングソケットを表すファイル記述子である。

listen()も参照のこと 。

QLocalServer::SocketOptions QLocalServer::socketOptions() const

ソケットに設定されているソケットオプションを返す。

setSocketOptions()も参照 。

bool QLocalServer::waitForNewConnection(int msec = 0, bool *timedOut = nullptr)

最大でmsec ミリ秒、または着信接続が利用可能になるまで待つ。接続が利用可能な場合はtrue を返し、そうでない場合はfalse を返す。操作がタイムアウトし、timedOut がnullptr でない場合、*timedOut が true に設定される。

これはブロッキング関数呼び出しである。waitForNewConnection()は、利用可能なイベント・ループがない場合に主に有用である。

ノンブロッキングの代替手段は、newConnection （）シグナルに接続することである。

msec が -1 の場合、この関数はタイムアウトしない。

hasPendingConnections() およびnextPendingConnection()も参照の こと。