QAbstractSocket Class

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

QAbstractSocket::QAbstractSocket(QAbstractSocket::SocketType socketType, QObject *parent)

socketType 型の新しい抽象ソケットを作成します。parent 引数は、QObject のコンストラクタに渡されます。

socketType()、QTcpSocket 、およびQUdpSocketも参照してください 。

[virtual noexcept] QAbstractSocket::~QAbstractSocket()

ソケットを破棄します。

void QAbstractSocket::abort()

現在の接続を中止し、ソケットをリセットします。disconnectFromHost() とは異なり、この関数はソケットを直ちに閉じ、書き込みバッファに残っている未送信のデータを破棄します。

disconnectFromHost() およびclose()も参照してください 。

[virtual] bool QAbstractSocket::bind(const QHostAddress &address, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

ポートport で、BindMode mode を使用して、address にバインドします。

UDPソケットの場合、バインド後、指定されたアドレスとポートにUDPデータグラムが到着するたびに、QUdpSocket::readyRead()シグナルが発信されます。したがって、この関数はUDPサーバーの作成に役立ちます。

TCP ソケットの場合、この関数を使用して、送信接続に使用するインターフェースを指定できます。これは、複数のネットワークインターフェースがある場合に役立ちます。

デフォルトでは、ソケットはDefaultForPlatform BindMode を使用してバインドされます。ポートが指定されていない場合は、ランダムなポートが選択されます。

成功した場合、この関数はtrue を返し、ソケットはBoundState 状態になります。失敗した場合はfalse を返します。

bool QAbstractSocket::bind(quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

ポートport に対して、QHostAddress:Any にバインドし、BindMode mode を使用します。

デフォルトでは、DefaultForPlatform BindMode を使用してソケットがバインドされます。ポートが指定されていない場合は、ランダムなポートが選択されます。

[since 6.2] bool QAbstractSocket::bind(QHostAddress::SpecialAddress addr, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

BindMode （mode ）を使用して、ポートport の特殊アドレスaddr にバインドします。

デフォルトでは、ソケットはDefaultForPlatform BindMode を使用してバインドされます。ポートが指定されていない場合は、ランダムなポートが選択されます。

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

[override virtual] qint64 QAbstractSocket::bytesAvailable() const

QIODevice::bytesAvailable() const を再実装します。

読み取り待ちの状態にある受信バイト数を返します。

bytesToWrite() およびread()も参照してください 。

[override virtual] qint64 QAbstractSocket::bytesToWrite() const

QIODevice::bytesToWrite() const を再実装します。

書き込み待ちのバイト数を返します。これらのバイトは、制御がイベントループに戻ったとき、またはflush()が呼び出されたときに書き込まれます。

bytesAvailable() およびflush()も参照してください 。

[override virtual] void QAbstractSocket::close()

QIODevice::close() を再実装します。

ソケットのI/Oデバイスを閉じ、disconnectFromHost()を呼び出してソケットの接続を閉じます。

I/O デバイスが閉じられたときに発生する動作の詳細については、QIODevice::close() を参照してください。

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

[virtual] void QAbstractSocket::connectToHost(const QString &hostName, quint16 port, QIODeviceBase::OpenMode openMode = ReadWrite, QAbstractSocket::NetworkLayerProtocol protocol = AnyIPProtocol)

指定されたport で、hostName への接続を試みます。protocol パラメータを使用すると、使用するネットワークプロトコル（例：IPv4またはIPv6）を指定できます。

ソケットは指定されたopenMode で開かれ、まずHostLookupState に入り、次にhostName のホスト名検索を実行します。検索が成功した場合、hostFound()が発行され、QAbstractSocket はConnectingState に入ります。その後、検索によって返されたアドレスまたはアドレス群への接続を試みます。最後に、接続が確立されると、QAbstractSocket はConnectedState に入り、connected()を発行します。

どの時点でも、ソケットはerrorOccurred() を発行して、エラーが発生したことを通知することができます。

hostName は、文字列形式の IP アドレス（例: "43.195.83.32"）でも、ホスト名（例: "example.com"）でもかまいません。QAbstractSocket は、必要な場合にのみ検索を行います。port はネイティブのバイト順で指定されます。

state()、peerName()、peerAddress()、peerPort()、およびwaitForConnected()も参照してください 。

void QAbstractSocket::connectToHost(const QHostAddress &address, quint16 port, QIODeviceBase::OpenMode openMode = ReadWrite)

ポートport でのaddress への接続を試行しています。

[signal] void QAbstractSocket::connected()

このシグナルは、connectToHost() が呼び出され、接続が正常に確立された後に発せられます。

関連項目： connectToHost() およびdisconnected()。

[virtual] void QAbstractSocket::disconnectFromHost()

ソケットを閉じる試みを行います。書き込み待ちのデータがある場合、QAbstractSocket はClosingState 状態に入り、すべてのデータが書き込まれるまで待機します。最終的にはUnconnectedState 状態に入り、disconnected()シグナルを発行します。

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

[signal] void QAbstractSocket::disconnected()

このシグナルは、ソケットの接続が切断されたときに発生します。

関連項目： connectToHost()、disconnectFromHost()、およびabort()。

QAbstractSocket::SocketError QAbstractSocket::error() const

最後に発生したエラーのタイプを返します。

state() およびerrorString()も参照してください 。

[signal] void QAbstractSocket::errorOccurred(QAbstractSocket::SocketError socketError)

このシグナルは、エラーが発生した後に発せられます。socketError パラメータは、発生したエラーの種類を表します。

このシグナルが発生した際、ソケットは再接続の試行に対応できる状態ではない可能性があります。その場合は、イベントループから再接続を試みる必要があります。例えば、タイムアウトに 0ns を指定して QChronoTimer::singleShot() を使用します。

QAbstractSocket::SocketError は登録済みのメタタイプではないため、キュー化された接続については、Q_DECLARE_METATYPE() およびqRegisterMetaType() を使用して登録する必要があります。

error()、errorString()、および「カスタム Qt タイプの作成」も参照してください 。

bool QAbstractSocket::flush()

この関数は、ブロックすることなく、内部の書き込みバッファから基になるネットワークソケットへ、可能な限り多くのデータを書き込みます。データが書き込まれた場合、この関数は `true` を返します。そうでない場合は `false` を返します。

QAbstractSocket がバッファされたデータの送信を直ちに開始する必要がある場合は、この関数を呼び出してください。正常に書き込まれたバイト数はオペレーティングシステムによって異なります。ほとんどの場合、制御がイベントループに戻るとQAbstractSocket が自動的にデータの送信を開始するため、この関数を呼び出す必要はありません。イベントループがない場合は、代わりにwaitForBytesWritten()を呼び出してください。

write() およびwaitForBytesWritten()も参照してください 。

[signal] void QAbstractSocket::hostFound()

このシグナルは、connectToHost() が呼び出され、ホストの検索が成功した後に発火します。

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

[override virtual] bool QAbstractSocket::isSequential() const

QIODevice::isSequential() const を再実装します。

bool QAbstractSocket::isValid() const

ソケットが有効で、使用可能な状態であればtrue を返し、そうでない場合はfalse を返します。

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

QHostAddress QAbstractSocket::localAddress() const

利用可能な場合はローカルソケットのホストアドレスを返し、そうでない場合はQHostAddress::Null を返します。

これは通常、ホストのメインの IP アドレスですが、ローカルホストへの接続の場合は `QHostAddress::LocalHost ` (127.0.0.1) になることもあります。

localPort()、peerAddress()、およびsetLocalAddress()も参照してください 。

quint16 QAbstractSocket::localPort() const

利用可能な場合は、ローカルソケットのホストポート番号（ネイティブのバイト順）を返します。利用できない場合は 0 を返します。

localAddress()、peerPort()、およびsetLocalPort()も参照してください 。

QAbstractSocket::PauseModes QAbstractSocket::pauseMode() const

このソケットの一時停止モードを返します。

setPauseMode() およびresume()も参照してください 。

QHostAddress QAbstractSocket::peerAddress() const

ソケットがConnectedState の状態にある場合、接続先のピアのアドレスを返します。それ以外の場合は、QHostAddress::Null を返します。

peerName()、peerPort()、localAddress()、およびsetPeerAddress()も参照してください 。

QString QAbstractSocket::peerName() const

connectToHost() で指定されたピア名を返します。connectToHost() が呼び出されていない場合は、空のQString を返します。

peerAddress()、peerPort()、およびsetPeerName()も参照してください 。

quint16 QAbstractSocket::peerPort() const

ソケットがConnectedState の状態にある場合、接続先のピアのポート番号を返します。それ以外の場合は0を返します。

peerAddress()、localPort()、およびsetPeerPort()も参照してください 。

QString QAbstractSocket::protocolTag() const

このソケットのプロトコルタグを返します。プロトコルタグが設定されている場合、内部でこのソケットが作成される際に、QNetworkProxyQuery にこの値が渡され、使用するプロトコルタグとして指定されます。

setProtocolTag() およびQNetworkProxyQueryも参照してください 。

QNetworkProxy QAbstractSocket::proxy() const

このソケットのネットワークプロキシを返します。デフォルトでは `QNetworkProxy::DefaultProxy ` が使用されるため、このソケットはアプリケーションのデフォルトのプロキシ設定を照会します。

setProxy()、QNetworkProxy 、およびQNetworkProxyFactoryも参照してください 。

[signal] void QAbstractSocket::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)

このシグナルは、認証を必要とするproxy が使用された際に発生する可能性があります。その場合、authenticator オブジェクトに必要な詳細情報を入力することで、認証を行い、接続を継続することができます。

「 QAuthenticator 」および「QNetworkProxy 」も参照してください 。

qint64 QAbstractSocket::readBufferSize() const

内部の読み取りバッファのサイズを返します。これにより、read() またはreadAll() を呼び出す前に、クライアントが受信できるデータ量が制限されます。

読み取りバッファのサイズが 0（デフォルト）の場合、バッファにサイズ制限がなく、データが失われることがありません。

setReadBufferSize() およびread()も参照してください 。

[override virtual protected] qint64 QAbstractSocket::readData(char *data, qint64 maxSize)

QIODevice::readData （char *data, qint64 maxSize）を再実装します。

[override virtual protected] qint64 QAbstractSocket::readLineData(char *data, qint64 maxlen)

QIODevice::readLineData （char *data, qint64 maxSize）を再実装します。

[virtual] void QAbstractSocket::resume()

ソケットでのデータ転送を続行します。このメソッドは、ソケットが通知時に一時停止するように設定され、かつ通知が受信された後にのみ使用してください。現在サポートされている通知は、QSslSocket::sslErrors() のみです。ソケットが一時停止状態でない場合にこのメソッドを呼び出すと、未定義の挙動が生じます。

pauseMode() およびsetPauseMode()も参照してください 。

[protected] void QAbstractSocket::setLocalAddress(const QHostAddress &address)

接続のローカル側のアドレスをaddress に設定します。

QAbstractSocket のサブクラス内でこの関数を呼び出すことで、接続確立後にlocalAddress()関数の戻り値を変更することができます。この機能は、仮想接続設定を行うプロキシ接続で一般的に使用されます。

なお、この関数は、接続確立前（例：QAbstractSocket::bind()）にソケットのローカルアドレスをバインドするものではありません。

localAddress()、setLocalPort()、およびsetPeerAddress()も参照してください 。

[protected] void QAbstractSocket::setLocalPort(quint16 port)

接続のローカル側のポートをport に設定します。

QAbstractSocket のサブクラス内でこの関数を呼び出すことで、接続確立後にlocalPort()関数の戻り値を変更することができます。この機能は、仮想接続の設定を行うプロキシ接続で一般的に使用されます。

なお、この関数は、接続（例：QAbstractSocket::bind()）の確立前にソケットのローカルポートをバインドするものではありません。

localPort()、localAddress()、setLocalAddress()、およびsetPeerPort()も参照してください 。

void QAbstractSocket::setPauseMode(QAbstractSocket::PauseModes pauseMode)

通知を受信した際に処理を一時停止するかどうかを制御します。pauseMode パラメータは、ソケットを一時停止すべき条件を指定します。 現在サポートされている通知は、QSslSocket::sslErrors() のみです。PauseOnSslErrors に設定すると、ソケット上のデータ転送が一時停止され、resume() を呼び出して明示的に再開する必要があります。デフォルトでは、このオプションはPauseNever に設定されています。このオプションは、サーバーに接続する前に呼び出す必要があります。そうしないと、未定義の挙動を引き起こします。

pauseMode() およびresume()も参照してください 。

[protected] void QAbstractSocket::setPeerAddress(const QHostAddress &address)

接続のリモート側のアドレスを `address` に設定します。

QAbstractSocket のサブクラス内でこの関数を呼び出すことで、接続確立後にpeerAddress()関数の戻り値を変更することができます。この機能は、仮想接続の設定を行うプロキシ接続で一般的に使用されます。

peerAddress()、setPeerPort()、およびsetLocalAddress()も参照してください 。

[protected] void QAbstractSocket::setPeerName(const QString &name)

リモートピアのホスト名をname に設定します。

QAbstractSocket のサブクラス内でこの関数を呼び出すことで、接続確立後にpeerName()関数の戻り値を変更することができます。この機能は、仮想接続の設定を行うプロキシ接続で一般的に使用されます。

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

[protected] void QAbstractSocket::setPeerPort(quint16 port)

接続のリモート側のポートをport に設定します。

QAbstractSocket のサブクラス内でこの関数を呼び出すことで、接続確立後にpeerPort()関数の戻り値を変更することができます。この機能は、仮想接続設定のためのプロキシ接続で一般的に使用されます。

peerPort()、setPeerAddress()、およびsetLocalPort()も参照してください 。

void QAbstractSocket::setProtocolTag(const QString &tag)

このソケットのプロトコルタグを「tag 」に設定します。

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

void QAbstractSocket::setProxy(const QNetworkProxy &networkProxy)

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

このソケットでのプロキシの使用を無効にするには、QNetworkProxy::NoProxy というプロキシタイプを使用します:

socket->setProxy(QNetworkProxy::NoProxy);

プロキシのデフォルト値は `QNetworkProxy::DefaultProxy` です。これは、ソケットがアプリケーションの設定を使用することを意味します。つまり、QNetworkProxy::setApplicationProxy でプロキシが設定されている場合はそれを使用し、そうでない場合は、QNetworkProxyFactory::setApplicationProxyFactory でファクトリが設定されている場合、QNetworkProxyQuery::TcpSocket タイプでそのファクトリに問い合わせを行います。

proxy()、QNetworkProxy 、およびQNetworkProxyFactory::queryProxy()も参照してください 。

[virtual] void QAbstractSocket::setReadBufferSize(qint64 size)

QAbstractSocket の内部読み取りバッファのサイズをsize バイトに設定します。

バッファサイズが特定のサイズに制限されている場合、QAbstractSocket はこのサイズを超えるデータはバッファに格納しません。例外として、バッファサイズが 0 の場合、読み取りバッファに制限はなく、受信したすべてのデータがバッファに格納されます。これがデフォルトの設定です。

このオプションは、特定の時点でのみデータを読み取る場合（例：リアルタイムストリーミングアプリケーション）や、ソケットが過剰なデータを受信して、最終的にアプリケーションのメモリ不足を招くのを防ぎたい場合に役立ちます。

QTcpSocket のみがQAbstractSocket の内部バッファを使用します。QUdpSocket はバッファリングを一切行わず、代わりにオペレーティングシステムが提供する暗黙的なバッファリングに依存します。このため、QUdpSocket に対してこの関数を呼び出しても何の効果もありません。

readBufferSize() およびread()も参照してください 。

[virtual] bool QAbstractSocket::setSocketDescriptor(qintptr socketDescriptor, QAbstractSocket::SocketState socketState = ConnectedState, QIODeviceBase::OpenMode openMode = ReadWrite)

ネイティブソケット記述子 `socketDescriptor` を使用して、QAbstractSocket を初期化します。socketDescriptor が有効なソケット記述子として受け入れられた場合は `true ` を返し、そうでない場合は `false` を返します。ソケットは `openMode` で指定されたモードで開かれ、`socketState` で指定されたソケット状態になります。読み取りおよび書き込みバッファはクリアされ、保留中のデータはすべて破棄されます。

注：同じネイティブソケット記述子を使用して、2つの抽象ソケットを初期化することはできません。

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

[protected] void QAbstractSocket::setSocketError(QAbstractSocket::SocketError socketError)

最後に発生したエラーの種類を `socketError` に設定します。

setSocketState() およびsetErrorString()も参照してください 。

[virtual] void QAbstractSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

指定されたoption を、value で記述された値に設定します。

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

[protected] void QAbstractSocket::setSocketState(QAbstractSocket::SocketState state)

ソケットの状態をstate に設定します。

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

[override virtual protected] qint64 QAbstractSocket::skipData(qint64 maxSize)

QIODevice::skipData （qint64 maxSize）を再実装しています。

[virtual] qintptr QAbstractSocket::socketDescriptor() const

QAbstractSocket オブジェクトのネイティブソケット記述子が利用可能な場合はそれを返し、利用できない場合は-1を返します。

ソケットがQNetworkProxy を使用している場合、返される記述子はネイティブのソケット関数では使用できない可能性があります。

QAbstractSocket がUnconnectedState の状態にある場合、ソケット記述子は利用できません。

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

[virtual] QVariant QAbstractSocket::socketOption(QAbstractSocket::SocketOption option)

option オプションの値を返します。

「setSocketOption()」も参照してください 。

QAbstractSocket::SocketType QAbstractSocket::socketType() const

ソケットのタイプ（TCP、UDP、その他）を返します。

QTcpSocket およびQUdpSocketも参照してください 。

QAbstractSocket::SocketState QAbstractSocket::state() const

ソケットの状態を返します。

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

[signal] void QAbstractSocket::stateChanged(QAbstractSocket::SocketState socketState)

このシグナルは、QAbstractSocket の状態が変化するたびに発火します。socketState パラメータは新しい状態を表します。

QAbstractSocket::SocketState は登録済みのメタタイプではないため、キュー化された接続の場合は、Q_DECLARE_METATYPE() およびqRegisterMetaType() を使用して登録する必要があります。

state() および「カスタム Qt 型の作成」も参照してください 。

[override virtual] bool QAbstractSocket::waitForBytesWritten(int msecs = 30000)

QIODevice::waitForBytesWritten(int msecs) の再実装です。

この関数は、ソケットに少なくとも1バイトが書き込まれ、bytesWritten() シグナルが発行されるまでブロックします。この関数は、msecs ミリ秒後にタイムアウトします。デフォルトのタイムアウト値は30000ミリ秒です。

bytesWritten() シグナルが発せられた場合、この関数はtrue を返します。それ以外の場合は、エラーが発生した場合や操作がタイムアウトした場合にfalse を返します。

関連項目： waitForReadyRead()。

[virtual] bool QAbstractSocket::waitForConnected(int msecs = 30000)

ソケットが接続されるまで、最大msecs ミリ秒待機します。接続が確立された場合、この関数はtrue を返します。そうでない場合は、false を返します。false が返された場合は、error()を呼び出して、エラーの原因を特定することができます。

次の例では、接続が確立されるまで最大1秒間待機します：

socket->connectToHost("imap", 143);
if(socket->waitForConnected(1000))
    qDebug("Connected!");

msecs が -1 の場合、この関数はタイムアウトしません。

関連項目： connectToHost() およびconnected()。

[virtual] bool QAbstractSocket::waitForDisconnected(int msecs = 30000)

ソケットの接続が切断されるまで待機します。待機時間は最大msecs ミリ秒です。接続が正常に切断された場合、この関数はtrue を返します。それ以外の場合、false を返します（操作がタイムアウトした場合、エラーが発生した場合、またはこのQAbstractSocket がすでに切断されている場合）。false が返された場合は、error()を呼び出してエラーの原因を特定できます。

次の例は、接続が閉じられるまで最大1秒間待機します：

socket->disconnectFromHost();
if(socket->state()==QAbstractSocket::UnconnectedState
    || socket->waitForDisconnected(1000)) {
        qDebug("Disconnected!");
}

msecs が -1 の場合、この関数はタイムアウトしません。

関連項目： disconnectFromHost() およびclose()。

[override virtual] bool QAbstractSocket::waitForReadyRead(int msecs = 30000)

QIODevice::waitForReadyRead(int msecs) を再実装します。

この関数は、読み取り可能な新しいデータが利用可能になり、readyRead() シグナルが発行されるまで待機します。この関数は、msecs ミリ秒後にタイムアウトします。デフォルトのタイムアウト時間は 30000 ミリ秒です。

readyRead() シグナルが発行され、読み取り可能な新しいデータが存在する場合、この関数はtrue を返します。それ以外の場合（エラーが発生した場合や操作がタイムアウトした場合）、false を返します。

関連項目： waitForBytesWritten()。

[override virtual protected] qint64 QAbstractSocket::writeData(const char *data, qint64 size)

QIODevice::writeData(const char *data, qint64 maxSize) を再実装します。