QTcpServer Class

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

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

QTcpServer オブジェクトを構築します。

parent は コンストラクタに渡されます。QObject

listen() およびsetSocketDescriptor()も参照してください 。

[virtual noexcept] QTcpServer::~QTcpServer()

QTcpServer オブジェクトを破棄します。サーバーが接続をリッスンしている場合、ソケットは自動的に閉じられます。

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

close()も参照のこと 。

[signal] void QTcpServer::acceptError(QAbstractSocket::SocketError socketError)

このシグナルは、新しい接続を受け付けた結果エラーが発生した場合に発行される。socketError パラメータには、発生したエラーのタイプが記述される。

pauseAccepting() およびresumeAccepting() も参照 。

[protected] void QTcpServer::addPendingConnection(QTcpSocket *socket)

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

incomingConnection() およびpendingConnectionAvailable()も参照のこと 。

void QTcpServer::close()

サーバを終了します。サーバはもはや着信接続を待ちません。

listen() も参照 。

QString QTcpServer::errorString() const

最後に発生したエラーの内容を可読形式で返します。

serverError() も参照 。

[virtual] bool QTcpServer::hasPendingConnections() const

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

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

[virtual protected] void QTcpServer::incomingConnection(qintptr socketDescriptor)

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

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

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

QTcpSocket::setSocketDescriptorこのサーバがQNetworkProxy を使用している場合、socketDescriptor はネイティブソケット関数では使用できない可能性がある。

newConnection()、nextPendingConnection()、addPendingConnection()も参照のこと 。

bool QTcpServer::isListening() const

サーバが現在着信接続をリッスンしている場合はtrue を返し、そうでない場合はfalse を返す。

listen() も参照 。

bool QTcpServer::listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0)

アドレスaddress およびポートport で着信接続を待ち受けるようにサーバに指示します。port が 0 の場合、ポートは自動的に選択されます。address がQHostAddress::Any の場合、サーバはすべてのネットワーク・インタフェースをリッスンする。

成功した場合はtrue を返し、そうでない場合はfalse を返す。

isListening()も参照のこと 。

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

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

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

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

int QTcpServer::maxPendingConnections() const

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

setMaxPendingConnections() およびhasPendingConnections() も参照して ください。

[signal] void QTcpServer::newConnection()

このシグナルは、保留中の接続キューに追加されているかどうかに関わらず、 新しい接続が利用可能になるたびに発行されます。

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

[virtual] QTcpSocket *QTcpServer::nextPendingConnection()

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

ソケットはサーバの子として生成されるので、QTcpServer オブジェクトが破棄されると自動的に削除される。メモリの浪費を避けるために、オブジェクトを使い終わったら明示的に削除するのは良いアイデアである。

nullptr 保留中の接続がないときにこの関数を呼び出すと、 オブジェクトが返されます。

hasPendingConnections()も参照 。

void QTcpServer::pauseAccepting()

新しい接続の受け付けを一時停止します。キューに入れられた接続はキューに残ります。

resumeAccepting()も参照 。

[private signal, since 6.4] void QTcpServer::pendingConnectionAvailable()

このシグナルは、保留中の接続キューに新しい接続が追加されるたびに発行されます。

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

hasPendingConnections() およびnextPendingConnection()も参照してください 。

QNetworkProxy QTcpServer::proxy() const

このソケットのネットワークプロキシを返します。デフォルトではQNetworkProxy::DefaultProxy が使用される。

setProxy() およびQNetworkProxy も参照 。

void QTcpServer::resumeAccepting()

新しい接続の受け付けを再開します。

pauseAccepting()も参照 。

QHostAddress QTcpServer::serverAddress() const

サーバーが接続をリッスンしている場合はサーバーのアドレスを返し、そうでない場合はQHostAddress::Null を返す。

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

QAbstractSocket::SocketError QTcpServer::serverError() const

最後に発生したエラーのエラーコードを返します。

errorString() も参照 。

quint16 QTcpServer::serverPort() const

サーバが接続をリッスンしている場合はサーバのポートを返し、そうでない場合は 0 を返します。

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

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

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

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

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

void QTcpServer::setMaxPendingConnections(int numConnections)

numConnections QTcpServer は、 () が呼び出される前に、 を超える着信接続を受け付けません。デフォルトでは、保留中の接続数の上限は30である。nextPendingConnection numConnections

サーバが保留中の接続数の上限に達した後でも、クライアントは接続できる (つまり、QTcpSocket はまだ connected() シグナルを送出できる)。QTcpServer は新しい接続の受け付けを停止するが、オペレーティングシステムはそれらの接続を キューに残しておくことができる。

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

void QTcpServer::setProxy(const QNetworkProxy &networkProxy)

このソケットの明示的なネットワークプロキシをnetworkProxy に設定する。

このソケットのプロキシを無効にするには、QNetworkProxy::NoProxy プロキシ型を使用する：

server->setProxy(QNetworkProxy::NoProxy);

proxy() およびQNetworkProxyも参照 。

bool QTcpServer::setSocketDescriptor(qintptr socketDescriptor)

このサーバが着信接続をリッスンするときに使用するソケットディスクリプタをsocketDescriptor に設定する。ソケットの設定に成功した場合はtrue を返し、失敗した場合はfalse を返す。

ソケットはリッスン中であると仮定する。

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

qintptr QTcpServer::socketDescriptor() const

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

サーバがQNetworkProxy を使用している場合、返された記述子はネイティブソケット関数で使用できないかもしれない。

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

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

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

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

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

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

hasPendingConnections() およびnextPendingConnection()も参照して ください。