Partager via


WebSocketTransport class

Transport basé sur un socket web.

Constructeurs

WebSocketTransport(ISocket)

Crée une instance de la classe WebSocketTransport.

Propriétés

isConnected

Retourne true si le transport est connecté à un socket.

Méthodes

close()

Fermez le socket à quoi ce transport est connecté.

onReceive(INodeBuffer)

Définit le transport pour tenter de recevoir des données entrantes qui n’ont pas encore été arrivées.

receive(number)

Tentez de recevoir des données entrantes à partir du socket connecté.

send(INodeBuffer)

Envoie la mémoire tampon donnée sur la connexion du socket.

Détails du constructeur

WebSocketTransport(ISocket)

Crée une instance de la classe WebSocketTransport.

new WebSocketTransport(ws: ISocket)

Paramètres

ws
ISocket

ISocket pour construire ce transport en plus.

Détails de la propriété

isConnected

Retourne true si le transport est connecté à un socket.

boolean isConnected

Valeur de propriété

boolean

true si le transport est connecté et prêt à envoyer des données, false sinon.

Détails de la méthode

close()

Fermez le socket à quoi ce transport est connecté.

function close()

onReceive(INodeBuffer)

Définit le transport pour tenter de recevoir des données entrantes qui n’ont pas encore été arrivées.

function onReceive(data: INodeBuffer)

Paramètres

data
INodeBuffer

Mémoire tampon dans laquelle stocker les données entrantes.

receive(number)

Tentez de recevoir des données entrantes à partir du socket connecté.

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

Paramètres

count

number

Nombre d’octets à recevoir.

Retours

Promise<INodeBuffer>

Mémoire tampon remplie avec les données reçues.

send(INodeBuffer)

Envoie la mémoire tampon donnée sur la connexion du socket.

function send(buffer: INodeBuffer): number

Paramètres

buffer
INodeBuffer

Données mises en mémoire tampon à envoyer via la connexion.

Retours

number

Nombre indiquant la longueur des données envoyées si les données ont été correctement envoyées, sinon 0.