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)

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

UDPソケットの場合、バインド後、指定したアドレスとポートにUDPデータグラムが到着するたびにシグナルQUdpSocket::readyRead() が発せられる。したがって、この関数はUDPサーバーを記述するのに便利である。

TCPソケットの場合、この関数を使用して、発信接続に使用するインタフェースを指定することができる。

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

false成功すると、この関数はtrue を返し、ソケットはBoundState に入る。

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

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

BindMode mode を使ってQHostAddress:Any on portport にバインドする。

デフォルトでは、ソケットは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 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 を返します。

バッファリングされたデータの送信をすぐに開始する必要がある場合は、この関数を呼び出します(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

ローカルソケットのホストポート番号(ネイティブバイト順)を返す。

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 にある場合、接続相手のポートを返す。

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)

reimplementsを参照してください：QIODevice::waitForBytesWritten(int msecs).

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

デフォルトのタイムアウト時間は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) を再実装しています。