Partager via

WebSocketServer class

  • Référence
Paquet:
botframework-streaming

Serveur basé sur un socket web à utiliser comme transport de streaming.

Constructeurs

WebSocketServer(ISocket, RequestHandler)

Crée une instance de la classe WebSocketServer.

Propriétés

isConnected

Examine le ISocket stocké et retourne true si la connexion de socket est ouverte.

Méthodes

disconnect()

Arrêtez ce serveur.
send(StreamingRequest)

Tâche utilisée pour envoyer des données via cette connexion serveur.
start()

Utilisé pour établir la connexion utilisée par ce serveur et commencer à écouter les messages entrants.

Détails du constructeur

WebSocketServer(ISocket, RequestHandler)

Crée une instance de la classe WebSocketServer.

new WebSocketServer(socket: ISocket, requestHandler?: RequestHandler)

Paramètres

socket
ISocket

Socket web sous-jacent.

requestHandler
RequestHandler

Facultatif RequestHandler pour traiter les messages entrants reçus par ce serveur.

Détails de la propriété

isConnected

Examine le ISocket stocké et retourne true si la connexion de socket est ouverte.

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

disconnect()

Arrêtez ce serveur.

function disconnect()

send(StreamingRequest)

Tâche utilisée pour envoyer des données via cette connexion serveur.

function send(request: StreamingRequest): Promise<IReceiveResponse>

Paramètres

request
StreamingRequest

Demande de diffusion en continu à envoyer.

Retours

Promise<IReceiveResponse>

Promesse qui produira une instance de réponse de réception à l’achèvement de l’opération d’envoi.

start()

Utilisé pour établir la connexion utilisée par ce serveur et commencer à écouter les messages entrants.

function start(): Promise<string>

Retours

Promise<string>

Promesse de gérer l’opération d’écoute du serveur. Cette tâche ne se résout pas tant que le serveur est en cours d’exécution.