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()も参照して ください。