stingray.WebSocket オブジェクト リファレンス

説明

Web ソケット クライアント インタフェースを実装します。

コンストラクタとアクセサ

stingray.WebSocket()

その他の関連リファレンス項目

	stingray.WebSocket()
	Networking

この参照ページは、次の概要トピックと関連付けられています

「リリース ノート > Stingray 1.4 リリース ノート」

列挙

stingray.WebSocket.MessageType サポートされるメッセージ タイプです。

stingray.WebSocket.State Websocket の状態

関数

close ( self ) WebSocket を閉じます。

パラメータ

self :

stingray.WebSocket

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

この関数は値を返しません。

poll ( self ) : stingray.WebSocket.MessageType?, string? 新しいデータの WebSocket をポーリングします。

パラメータ

self :

stingray.WebSocket

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

MessageType?	返されるペイロードのタイプです(TEXT または BINARY)。新しいデータがない場合は、nil が返されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
string?	新しいデータがない場合は、メッセージまたは nil のペイロードです。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

send ( self, msg, type ) WebSocket メッセージを送信します。

パラメータ

self :	stingray.WebSocket	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
msg :	string	WebSocket を介して送信する文字列です。
type :	stingray.WebSocket.MessageType?	メッセージのタイプです(TEXT または BINARY)。特に指定しない限り、既定は TEXT になります。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

この関数は値を返しません。

state ( self ) : stingray.WebSocket.State WebSocket の現在の状態を返します。

パラメータ

self :

stingray.WebSocket

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

State

WebSocket の現在の状態です。