Condividi tramite

WebSocketTransport class

  • Riferimento
Pacchetto:
botframework-streaming

Trasporto basato su Web socket.

Costruttori

WebSocketTransport(ISocket)

Crea una nuova istanza della classe WebSocketTransport.

Proprietà

isConnected

Restituisce true se il trasporto è connesso a un socket.

Metodi

close()

Chiudere il socket a cui è connesso il trasporto.
onReceive(INodeBuffer)

Imposta il trasporto per tentare di ricevere i dati in ingresso non ancora arrivati.
receive(number)

Tentare di ricevere dati in ingresso dal socket connesso.
send(INodeBuffer)

Invia il buffer specificato sulla connessione del socket.

Dettagli costruttore

WebSocketTransport(ISocket)

Crea una nuova istanza della classe WebSocketTransport.

new WebSocketTransport(ws: ISocket)

Parametri

ws
ISocket

ISocket per costruire questo trasporto sopra.

Dettagli proprietà

isConnected

Restituisce true se il trasporto è connesso a un socket.

boolean isConnected

Valore della proprietà

boolean

true se il trasporto è connesso e pronto per l'invio di dati, false in caso contrario.

Dettagli metodo

close()

Chiudere il socket a cui è connesso il trasporto.

function close()

onReceive(INodeBuffer)

Imposta il trasporto per tentare di ricevere i dati in ingresso non ancora arrivati.

function onReceive(data: INodeBuffer)

Parametri

data
INodeBuffer

Buffer in cui archiviare i dati in ingresso.

receive(number)

Tentare di ricevere dati in ingresso dal socket connesso.

function receive(count: number): Promise<INodeBuffer>

Parametri

count

number

Numero di byte da tentare di ricevere.

Restituisce

Promise<INodeBuffer>

Buffer popolato con i dati ricevuti.

send(INodeBuffer)

Invia il buffer specificato sulla connessione del socket.

function send(buffer: INodeBuffer): number

Parametri

buffer
INodeBuffer

Dati memorizzati nel buffer da inviare tramite la connessione.

Restituisce

number

Numero che indica la lunghezza dei dati inviati se i dati sono stati inviati correttamente; in caso contrario, 0.