Compartir a través de

NodeWebSocket class

  • Referencia
Paquete:
botframework-streaming

Implementación de ISocket para usarla con un NodeWebSocketFactory para crear un servidor WebSocket.

Constructores

NodeWebSocket(WebSocket)

Crea una nueva instancia de NodeWebSocket.

Propiedades

isConnected

Indica si el WebSocket "ws" está conectado actualmente y listo para enviar mensajes.

Métodos

close(number, string)

Cierre el socket.
connect(string, number)

Se conecta al socket auxiliar mediante el protocolo WebSocket.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Cree y establezca un ws WebSocket con una solicitud HTTP, socket y búfer.
setOnCloseHandler((x: any) => void)

Establezca la devolución de llamada para llamar al encontrar cierres de socket.
setOnErrorHandler((x: any) => void)

Establezca la devolución de llamada para llamar al encontrar errores.
setOnMessageHandler((x: any) => void)

Establezca el controlador para 'data' y 'message' eventos recibidos en el socket.
write(INodeBuffer)

Escribe un búfer en el socket y lo envía.

Detalles del constructor

NodeWebSocket(WebSocket)

Crea una nueva instancia de NodeWebSocket.

new NodeWebSocket(wsSocket?: WebSocket)

Parámetros

wsSocket

WebSocket

La ws instancia de WebSocket para compilar esta conexión.

Detalles de las propiedades

isConnected

Indica si el WebSocket "ws" está conectado actualmente y listo para enviar mensajes.

boolean isConnected

Valor de propiedad

boolean

true si el websocket subyacente está listo y disponible para enviar mensajes; de lo contrario, false.

Detalles del método

close(number, string)

Cierre el socket.

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

Parámetros

code

number

Código de estado opcional para explicar por qué se ha cerrado la conexión.

data

string

Datos adicionales opcionales para explicar por qué se ha cerrado la conexión.

Comentarios

Opcionalmente, pase un código de estado y una cadena que explique por qué se cierra la conexión.

connect(string, number)

Se conecta al socket auxiliar mediante el protocolo WebSocket.

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

Parámetros

serverAddress

string

Dirección en la que escucha el servidor.

port

number

El puerto en el que escucha el servidor tiene como valor predeterminado 8082.

Devoluciones

Promise<void>

Promesa que se resuelve cuando se cierra la conexión de websocket o rechaza un error.

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Cree y establezca un ws WebSocket con una solicitud HTTP, socket y búfer.

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

Parámetros

req
INodeIncomingMessage

Una solicitud HTTP que coincida con la interfaz INodeIncomingMessage.

socket
INodeSocket

Interfaz INodeSocket de socket.

head
INodeBuffer

Interfaz de búfer INodeBuffer.

Devoluciones

Promise<void>

Promesa que se resuelve después de que se haya controlado la actualización de WebSocket; de lo contrario, rechaza con un error producido.

setOnCloseHandler((x: any) => void)

Establezca la devolución de llamada para llamar al encontrar cierres de socket.

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

Parámetros

handler

(x: any) => void

Devolución de llamada para controlar el evento "close".

setOnErrorHandler((x: any) => void)

Establezca la devolución de llamada para llamar al encontrar errores.

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

Parámetros

handler

(x: any) => void

Devolución de llamada para controlar el evento "error".

setOnMessageHandler((x: any) => void)

Establezca el controlador para 'data' y 'message' eventos recibidos en el socket.

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

Parámetros

handler

(x: any) => void

Devolución de llamada para controlar el evento "message".

write(INodeBuffer)

Escribe un búfer en el socket y lo envía.

function write(buffer: INodeBuffer)

Parámetros

buffer
INodeBuffer

Búfer de datos que se van a enviar a través de la conexión.