NodeWebSocket class
NodeWebSocketFactory と共に使用して WebSocket サーバーを作成する ISocket の実装。
コンストラクター
| Node |
新しい NodeWebSocket インスタンスを 作成します。 |
プロパティ
| is |
'ws' WebSocket が現在接続されていて、メッセージを送信する準備ができているかどうかを示します。 |
メソッド
| close(number, string) | ソケットを閉じます。 |
| connect(string, number) | WebSocket プロトコルを使用してサポート ソケットに接続します。 |
| create(INode |
HTTP 要求、ソケット、バッファーを |
| set |
ソケットクロージャが発生したときにを呼び出すようにコールバックを設定します。 |
| set |
エラーが発生したときに を呼び出すようにコールバックを設定します。 |
| set |
ソケットで受信した イベントと |
| write(INode |
バッファーをソケットに書き込み、送信します。 |
コンストラクターの詳細
NodeWebSocket(WebSocket)
新しい NodeWebSocket インスタンスを 作成します。
new NodeWebSocket(wsSocket?: WebSocket)パラメーター
- wsSocket
-
WebSocket
wsこの接続を構築する WebSocket インスタンス。
プロパティの詳細
isConnected
'ws' WebSocket が現在接続されていて、メッセージを送信する準備ができているかどうかを示します。
boolean isConnectedプロパティ値
boolean
true 基になる Websocket がメッセージを送信する準備が整い、メッセージを送信できる場合は 。それ以外の場合 falseは 。
メソッドの詳細
close(number, string)
ソケットを閉じます。
function close(code?: number, data?: string)パラメーター
- code
-
number
接続が閉じられた理由を説明するオプションの状態コード。
- data
-
string
接続が閉じられた理由を説明するオプションの追加データ。
注釈
必要に応じて、接続が閉じている理由を説明する状態コードと文字列を渡します。
connect(string, number)
WebSocket プロトコルを使用してサポート ソケットに接続します。
function connect(serverAddress: string, port?: number): Promise<void>パラメーター
- serverAddress
-
string
サーバーがリッスンしているアドレス。
- port
-
number
サーバーがリッスンしているポート。既定値は 8082 です。
戻り値
Promise<void>
Websocket 接続が閉じられたときに解決されるか、エラーで拒否される Promise。
create(INodeIncomingMessage, INodeSocket, INodeBuffer)
HTTP 要求、ソケット、バッファーを ws 使用して WebSocket を作成して設定します。
function create(req: INodeIncomingMessage, socket: INodeSocket, head: INodeBuffer): Promise<void>パラメーター
INodeIncomingMessage インターフェイスに一致する HTTP 要求。
- socket
- INodeSocket
ソケット INodeSocket インターフェイス。
- head
- INodeBuffer
Buffer INodeBuffer インターフェイス。
戻り値
Promise<void>
WebSocket のアップグレードが処理された後に解決される Promise。それ以外の場合は、スローされたエラーで拒否されます。
setOnCloseHandler((x: any) => void)
ソケットクロージャが発生したときにを呼び出すようにコールバックを設定します。
function setOnCloseHandler(handler: (x: any) => void)パラメーター
- handler
-
(x: any) => void
"close" イベントを処理するコールバック。
setOnErrorHandler((x: any) => void)
エラーが発生したときに を呼び出すようにコールバックを設定します。
function setOnErrorHandler(handler: (x: any) => void)パラメーター
- handler
-
(x: any) => void
"error" イベントを処理するコールバック。
setOnMessageHandler((x: any) => void)
ソケットで受信した イベントと 'message' イベントのハンドラー'data'を設定します。
function setOnMessageHandler(handler: (x: any) => void)パラメーター
- handler
-
(x: any) => void
"message" イベントを処理するコールバック。
write(INodeBuffer)
バッファーをソケットに書き込み、送信します。
function write(buffer: INodeBuffer)パラメーター
- buffer
- INodeBuffer
接続を介して送信するデータのバッファー。