Compartilhar via

NodeWebSocket class

  • Referência
Pacote:
botframework-streaming

Uma implementação de ISocket a ser usada com um NodeWebSocketFactory para criar um servidor WebSocket.

Construtores

NodeWebSocket(WebSocket)

Cria uma nova instância de nodeWebSocket .

Propriedades

isConnected

Indica se o WebSocket 'ws' está atualmente conectado e pronto para enviar mensagens.

Métodos

close(number, string)

Feche o soquete.
connect(string, number)

Conecta-se ao soquete de suporte usando o protocolo WebSocket.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Crie e defina um WebSocket ws com uma solicitação HTTP, soquete e buffer.
setOnCloseHandler((x: any) => void)

Defina o retorno de chamada para chamar ao encontrar fechamentos de soquete.
setOnErrorHandler((x: any) => void)

Defina o retorno de chamada para chamar ao encontrar erros.
setOnMessageHandler((x: any) => void)

Defina o manipulador para eventos de 'data' e 'message' recebidos no soquete.
write(INodeBuffer)

Grava um buffer no soquete e o envia.

Detalhes do construtor

NodeWebSocket(WebSocket)

Cria uma nova instância de nodeWebSocket .

new NodeWebSocket(wsSocket?: WebSocket)

Parâmetros

wsSocket

WebSocket

A instância ws WebSocket na qual criar essa conexão.

Detalhes da propriedade

isConnected

Indica se o WebSocket 'ws' está atualmente conectado e pronto para enviar mensagens.

boolean isConnected

Valor da propriedade

boolean

true se o websocket subjacente estiver pronto e útil para enviar mensagens, caso contrário, false.

Detalhes do método

close(number, string)

Feche o soquete.

function close(code?: number, data?: string)

Parâmetros

code

number

Código de status opcional para explicar por que a conexão foi fechada.

data

string

Dados adicionais opcionais para explicar por que a conexão foi fechada.

Comentários

Opcionalmente, passe um código de status e uma cadeia de caracteres explicando por que a conexão está fechando.

connect(string, number)

Conecta-se ao soquete de suporte usando o protocolo WebSocket.

function connect(serverAddress: string, port?: number): Promise<void>

Parâmetros

serverAddress

string

O endereço em que o servidor está escutando.

port

number

A porta em que o servidor está escutando, o padrão é 8082.

Retornos

Promise<void>

Uma promessa que é resolvida quando a conexão websocket é fechada ou rejeitada em um erro.

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Crie e defina um WebSocket ws com uma solicitação HTTP, soquete e buffer.

function create(req: INodeIncomingMessage, socket: INodeSocket, head: INodeBuffer): Promise<void>

Parâmetros

req
INodeIncomingMessage

Uma solicitação HTTP que corresponde à interface de INodeIncomingMessage .

socket
INodeSocket

Um soquete interface de INodeSocket.

head
INodeBuffer

Uma interface de do Buffer INodeBuffer.

Retornos

Promise<void>

Uma promessa que é resolvida após a atualização do WebSocket ter sido tratada, caso contrário, é rejeitada com um erro gerado.

setOnCloseHandler((x: any) => void)

Defina o retorno de chamada para chamar ao encontrar fechamentos de soquete.

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

Parâmetros

handler

(x: any) => void

O retorno de chamada para lidar com o evento "close".

setOnErrorHandler((x: any) => void)

Defina o retorno de chamada para chamar ao encontrar erros.

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

Parâmetros

handler

(x: any) => void

O retorno de chamada para lidar com o evento de "erro".

setOnMessageHandler((x: any) => void)

Defina o manipulador para eventos de 'data' e 'message' recebidos no soquete.

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

Parâmetros

handler

(x: any) => void

O retorno de chamada para lidar com o evento "message".

write(INodeBuffer)

Grava um buffer no soquete e o envia.

function write(buffer: INodeBuffer)

Parâmetros

buffer
INodeBuffer

O buffer de dados a serem enviados pela conexão.