Partager via

NodeWebSocket class

  • Référence
Paquet:
botframework-streaming

Implémentation de ISocket à utiliser avec un NodeWebSocketFactory pour créer un serveur WebSocket.

Constructeurs

NodeWebSocket(WebSocket)

Crée une instance NodeWebSocket.

Propriétés

isConnected

Indique si le WebSocket « ws » est actuellement connecté et prêt à envoyer des messages.

Méthodes

close(number, string)

Fermez le socket.
connect(string, number)

Se connecte au socket de prise en charge à l’aide du protocole WebSocket.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Créez et définissez un ws WebSocket avec une requête HTTP, un socket et une mémoire tampon.
setOnCloseHandler((x: any) => void)

Définissez le rappel à appeler lors de la rencontre de fermetures de sockets.
setOnErrorHandler((x: any) => void)

Définissez le rappel à appeler lors de la rencontre d’erreurs.
setOnMessageHandler((x: any) => void)

Définissez le gestionnaire pour les événements 'data' et 'message' reçus sur le socket.
write(INodeBuffer)

Écrit une mémoire tampon dans le socket et l’envoie.

Détails du constructeur

NodeWebSocket(WebSocket)

Crée une instance NodeWebSocket.

new NodeWebSocket(wsSocket?: WebSocket)

Paramètres

wsSocket

WebSocket

Instance ws WebSocket sur laquelle générer cette connexion.

Détails de la propriété

isConnected

Indique si le WebSocket « ws » est actuellement connecté et prêt à envoyer des messages.

boolean isConnected

Valeur de propriété

boolean

true si le websocket sous-jacent est prêt et disponible pour envoyer des messages, sinon false.

Détails de la méthode

close(number, string)

Fermez le socket.

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

Paramètres

code

number

Code d’état facultatif pour expliquer pourquoi la connexion a fermé.

data

string

Données supplémentaires facultatives pour expliquer pourquoi la connexion a fermé.

Remarques

Si vous le souhaitez, transmettez un code d’état et une chaîne expliquant pourquoi la connexion se ferme.

connect(string, number)

Se connecte au socket de prise en charge à l’aide du protocole WebSocket.

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

Paramètres

serverAddress

string

Adresse sur laquelle le serveur écoute.

port

number

Le port sur lequel le serveur écoute, par défaut, est 8082.

Retours

Promise<void>

Promesse qui se résout lorsque la connexion websocket est fermée ou rejette une erreur.

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Créez et définissez un ws WebSocket avec une requête HTTP, un socket et une mémoire tampon.

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

Paramètres

req
INodeIncomingMessage

Requête HTTP correspondant à l’interface INodeIncomingMessage.

socket
INodeSocket

Interface INodeSocket.

head
INodeBuffer

Interface INodeBuffer tampon.

Retours

Promise<void>

Promesse qui se résout après la gestion de la mise à niveau de WebSocket, sinon rejette une erreur levée.

setOnCloseHandler((x: any) => void)

Définissez le rappel à appeler lors de la rencontre de fermetures de sockets.

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

Paramètres

handler

(x: any) => void

Rappel pour gérer l’événement « close ».

setOnErrorHandler((x: any) => void)

Définissez le rappel à appeler lors de la rencontre d’erreurs.

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

Paramètres

handler

(x: any) => void

Rappel pour gérer l’événement « erreur ».

setOnMessageHandler((x: any) => void)

Définissez le gestionnaire pour les événements 'data' et 'message' reçus sur le socket.

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

Paramètres

handler

(x: any) => void

Rappel pour gérer l’événement « message ».

write(INodeBuffer)

Écrit une mémoire tampon dans le socket et l’envoie.

function write(buffer: INodeBuffer)

Paramètres

buffer
INodeBuffer

Mémoire tampon des données à envoyer sur la connexion.