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)

詳細説明

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

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

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:// の 2 つのスキーマのいずれかを指定します。省略した場合はws://が使用されます。

シグナルのドキュメント

binaryMessageReceived(QString message)

このシグナルはバイナリメッセージを受信したときに発せられる。message には受信したバイトが格納される。

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

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 をサーバーに送信する。