NodeWebSocket class

  • リファレンス
パッケージ:
botframework-streaming

NodeWebSocketFactory と共に使用して WebSocket サーバーを作成するために使用する、ISocket の実装。

コンストラクター

NodeWebSocket(WebSocket)

NodeWebSocket インスタンス 新しいインスタンスを作成します。

プロパティ

isConnected

'ws' WebSocket が現在接続されていて、メッセージを送信する準備ができているかどうかを示します。

メソッド

close(number, string)

ソケットを閉じます。
connect(string, number)

WebSocket プロトコルを使用してサポート ソケットに接続します。
create(INodeIncomingMessage, INodeSocket, INodeBuffer)

HTTP 要求、ソケット、バッファーを使用して ws WebSocket を作成して設定します。
setOnCloseHandler((x: any) => void)

ソケットクロージャが発生したときに呼び出すコールバックを設定します。
setOnErrorHandler((x: any) => void)

エラーが発生したときに呼び出すコールバックを設定します。
setOnMessageHandler((x: any) => void)

ソケットで受信した 'data' イベントと 'message' イベントのハンドラーを設定します。
write(INodeBuffer)

バッファーをソケットに書き込んで送信します。

コンストラクターの詳細

NodeWebSocket(WebSocket)

NodeWebSocket インスタンス 新しいインスタンスを作成します。

new NodeWebSocket(wsSocket?: WebSocket)

パラメーター

wsSocket

WebSocket

この接続を構築する ws WebSocket インスタンス。

プロパティの詳細

isConnected

'ws' WebSocket が現在接続されていて、メッセージを送信する準備ができているかどうかを示します。

boolean isConnected

プロパティ値

boolean

基になる websocket が準備ができて、メッセージを送信できる場合は true、それ以外の場合は 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>

パラメーター

req
INodeIncomingMessage

INodeIncomingMessage インターフェイスに一致する HTTP 要求。

socket
INodeSocket

INodeSocket インターフェイス ソケット。

head
INodeBuffer

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)

ソケットで受信した 'data' イベントと 'message' イベントのハンドラーを設定します。

function setOnMessageHandler(handler: (x: any) => void)

パラメーター

handler

(x: any) => void

"message" イベントを処理するコールバック。

write(INodeBuffer)

バッファーをソケットに書き込んで送信します。

function write(buffer: INodeBuffer)

パラメーター

buffer
INodeBuffer

接続を介して送信するデータのバッファー。