WebSocketServer class
ストリーミング トランスポートとして使用する Web ソケット ベースのサーバー。
コンストラクター
| Web |
WebSocketServer クラスの新しいインスタンスを作成します。 |
プロパティ
| is |
格納されている ISocket を調べ、ソケット接続が開いているかどうかを返します |
メソッド
| disconnect() | このサーバーを停止します。 |
| send(Streaming |
このサーバー接続経由でデータを送信するために使用されるタスク。 |
| start() | このサーバーで使用される接続を確立し、受信メッセージのリッスンを開始するために使用します。 |
コンストラクターの詳細
WebSocketServer(ISocket, RequestHandler)
WebSocketServer クラスの新しいインスタンスを作成します。
new WebSocketServer(socket: ISocket, requestHandler?: RequestHandler)パラメーター
- socket
- ISocket
基になる Web ソケット。
- requestHandler
- RequestHandler
このサーバーが受信した受信メッセージを処理するための省略可能な RequestHandler 。
プロパティの詳細
isConnected
格納されている ISocket を調べ、ソケット接続が開いているかどうかを返します true 。
boolean isConnectedプロパティ値
boolean
true 基になる Websocket がメッセージを送信する準備が整い、メッセージを送信できる場合は 。それ以外の場合 falseは 。
メソッドの詳細
disconnect()
このサーバーを停止します。
function disconnect()
send(StreamingRequest)
このサーバー接続経由でデータを送信するために使用されるタスク。
function send(request: StreamingRequest): Promise<IReceiveResponse>パラメーター
- request
- StreamingRequest
送信するストリーミング要求。
戻り値
Promise<IReceiveResponse>
送信操作の完了時に受信応答のインスタンスを生成する promise。
start()
このサーバーで使用される接続を確立し、受信メッセージのリッスンを開始するために使用します。
function start(): Promise<string>戻り値
Promise<string>
サーバーのリッスン操作を処理する約束。 このタスクは、サーバーが実行されている限り解決されません。