WebSocket QML Type

QWebSocket への QML インターフェース。詳細...

• 継承されたメンバーを含む、すべてのメンバーの一覧

プロパティ

• active : bool
• errorString : string
• negotiatedSubprotocol : string (since 6.4)
• requestedSubprotocols : list<string> (since 6.4)
• status : Status
• url : url

信号

• binaryMessageReceived(QString message)
• pong(quint64 elapsedTime, ArrayBuffer payload) (since 6.10)
• statusChanged(Status status)
• textMessageReceived(QString message)

方法

• void ping() (since 6.10)
• void ping(ArrayBuffer payload) (since 6.10)
• void sendBinaryMessage(ArrayBuffer message)
• void sendTextMessage(string message)

詳細説明

WebSocketsは、単一のTCP接続を介して全二重通信チャネルを提供するWeb技術です。WebSocketプロトコルは、2011年にIETFによってRFC 6455として標準化されました。

プロパティのドキュメント

active : bool

true に設定すると、指定された URL を使用してサーバーへの接続が確立されます。false に設定すると、接続が切断されます。デフォルト値は false です。

errorString : string [read-only]

最後に発生したエラーの説明が含まれています。エラーが発生しなかった場合、この文字列は空になります。

negotiatedSubprotocol : string [read-only, since 6.4]

サーバーとの間でネゴシエーションされたWebSocketサブプロトコル。

このプロパティは Qt 6.4 で導入されました。

requestedSubprotocols : list<string> [since 6.4]

WebSocketハンドシェイクで送信するWebSocketサブプロトコルのリスト。

このプロパティはQt 6.4で導入されました。

status : Status [read-only]

WebSocket のステータス。

ステータスには以下の値があります：

• WebSocket.Connecting
• WebSocket.Open
• WebSocket.Closing
• WebSocket.Closed
• WebSocket.Error

url : url

接続先のサーバーのURL。URLには、ws://またはwss:// のいずれかのスキームを指定する必要があります。指定がない場合は、ws:// が使用されます。

Signal ドキュメント

binaryMessageReceived(QString message)

このシグナルは、バイナリメッセージを受信したときに発生します。message には、受信したバイトが格納されています。

[since 6.10] pong(quint64 elapsedTime, ArrayBuffer payload)

以前のpingに対する応答としてpongメッセージを受信した際に発行されます。elapsedTime には往復時間（ミリ秒単位）が、payload にはpingとともに送信されたオプションのペイロードが含まれます。

このシグナルは Qt 6.10 で導入されました。

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

statusChanged(Status status)

このシグナルは、WebSocketのステータスが変化した際に発生します。status 引数には、現在のステータスが渡されます。

「WebSocket::status」も参照してください 。

textMessageReceived(QString message)

このシグナルは、テキストメッセージを受信したときに発生します。message には、受信したバイトデータが含まれています。

メソッドのドキュメント

サーバーにpingを送信し、接続が維持されていることを通知します。pingメッセージとともに、追加のpayload を送信することもできます。

payload のサイズは125バイトを超えてはなりません。それより大きい場合、payload は125バイトに切り詰められます。

これらのメソッドは Qt 6.10 で導入されました。

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

void sendBinaryMessage(ArrayBuffer message)

パラメータ「message 」をサーバーに送信します。

void sendTextMessage(string message)

message をサーバーに送信します。