Condividi tramite

NodeWebSocket class

  • Riferimento
Pacchetto:
botframework-streaming

Implementazione di ISocket da usare con un NodeWebSocketFactory per creare un server WebSocket.

Costruttori

NodeWebSocket(WebSocket)

Crea una nuova istanza NodeWebSocket.

Proprietà

isConnected

Indica se il WebSocket 'ws' è attualmente connesso e pronto per l'invio di messaggi.

Metodi

close(number, string)

Chiudere il socket.
connect(string, number)

Si connette al socket di supporto usando il protocollo WebSocket.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Creare e impostare un ws WebSocket con una richiesta HTTP, un socket e un buffer.
setOnCloseHandler((x: any) => void)

Impostare il callback da chiamare quando si verificano le chiusura del socket.
setOnErrorHandler((x: any) => void)

Impostare il callback per chiamare quando si verificano errori.
setOnMessageHandler((x: any) => void)

Impostare il gestore per gli eventi 'data' e 'message' ricevuti nel socket.
write(INodeBuffer)

Scrive un buffer nel socket e lo invia.

Dettagli costruttore

NodeWebSocket(WebSocket)

Crea una nuova istanza NodeWebSocket.

new NodeWebSocket(wsSocket?: WebSocket)

Parametri

wsSocket

WebSocket

ws'istanza di WebSocket in cui compilare questa connessione.

Dettagli proprietà

isConnected

Indica se il WebSocket 'ws' è attualmente connesso e pronto per l'invio di messaggi.

boolean isConnected

Valore della proprietà

boolean

true se il websocket sottostante è pronto e disponibile per inviare messaggi; in caso contrario, false.

Dettagli metodo

close(number, string)

Chiudere il socket.

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

Parametri

code

number

Codice di stato facoltativo per spiegare il motivo per cui la connessione è stata chiusa.

data

string

Dati aggiuntivi facoltativi per spiegare il motivo per cui la connessione è stata chiusa.

Commenti

Facoltativamente, passare un codice di stato e una stringa che spiega perché la connessione viene chiusa.

connect(string, number)

Si connette al socket di supporto usando il protocollo WebSocket.

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

Parametri

serverAddress

string

Indirizzo su cui il server è in ascolto.

port

number

La porta su cui il server è in ascolto, il valore predefinito è 8082.

Restituisce

Promise<void>

Promessa che viene risolta quando la connessione websocket viene chiusa o rifiutata in caso di errore.

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Creare e impostare un ws WebSocket con una richiesta HTTP, un socket e un buffer.

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

Parametri

req
INodeIncomingMessage

Richiesta HTTP corrispondente all'interfaccia INodeIncomingMessage .

socket
INodeSocket

Interfaccia di Socket INodeSocket.

head
INodeBuffer

Interfaccia di buffer INodeBuffer.

Restituisce

Promise<void>

Promessa che viene risolta dopo che l'aggiornamento di WebSocket è stato gestito, altrimenti rifiuta con un errore generato.

setOnCloseHandler((x: any) => void)

Impostare il callback da chiamare quando si verificano le chiusura del socket.

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

Parametri

handler

(x: any) => void

Callback per gestire l'evento "close".

setOnErrorHandler((x: any) => void)

Impostare il callback per chiamare quando si verificano errori.

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

Parametri

handler

(x: any) => void

Callback per gestire l'evento "error".

setOnMessageHandler((x: any) => void)

Impostare il gestore per gli eventi 'data' e 'message' ricevuti nel socket.

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

Parametri

handler

(x: any) => void

Callback per gestire l'evento "message".

write(INodeBuffer)

Scrive un buffer nel socket e lo invia.

function write(buffer: INodeBuffer)

Parametri

buffer
INodeBuffer

Buffer dei dati da inviare attraverso la connessione.