Bagikan melalui

NodeWebSocket class

  • Referensi
Paket:
botframework-streaming

Implementasi ISocket untuk digunakan dengan NodeWebSocketFactory untuk membuat server WebSocket.

Konstruktor

NodeWebSocket(WebSocket)

Membuat instans NodeWebSocket baru.

Properti

isConnected

Menunjukkan apakah WebSocket 'ws' saat ini tersambung dan siap mengirim pesan.

Metode

close(number, string)

Tutup soket.
connect(string, number)

Menyambungkan ke soket pendukung menggunakan protokol WebSocket.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Buat dan atur ws WebSocket dengan Permintaan HTTP, Soket, dan Buffer.
setOnCloseHandler((x: any) => void)

Atur panggilan balik ke panggilan saat mengalami penutupan soket.
setOnErrorHandler((x: any) => void)

Atur panggilan balik ke panggilan saat mengalami kesalahan.
setOnMessageHandler((x: any) => void)

Atur handler untuk peristiwa 'data' dan 'message' yang diterima pada soket.
write(INodeBuffer)

Menulis buffer ke soket dan mengirimkannya.

Detail Konstruktor

NodeWebSocket(WebSocket)

Membuat instans NodeWebSocket baru.

new NodeWebSocket(wsSocket?: WebSocket)

Parameter

wsSocket

WebSocket

Instans webSocket ws untuk membangun koneksi ini.

Detail Properti

isConnected

Menunjukkan apakah WebSocket 'ws' saat ini tersambung dan siap mengirim pesan.

boolean isConnected

Nilai Properti

boolean

true jika websocket yang mendasar siap dan tersedia untuk mengirim pesan, jika tidak, false.

Detail Metode

close(number, string)

Tutup soket.

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

Parameter

code

number

Kode status opsional untuk menjelaskan mengapa koneksi telah ditutup.

data

string

Data tambahan opsional untuk menjelaskan mengapa koneksi telah ditutup.

Keterangan

Secara opsional meneruskan kode status dan string yang menjelaskan mengapa koneksi ditutup.

connect(string, number)

Menyambungkan ke soket pendukung menggunakan protokol WebSocket.

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

Parameter

serverAddress

string

Alamat yang didengarkan server.

port

number

Port yang didengarkan server, default ke 8082.

Mengembalikan

Promise<void>

Janji yang diselesaikan saat koneksi websocket ditutup, atau menolak kesalahan.

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Buat dan atur ws WebSocket dengan Permintaan HTTP, Soket, dan Buffer.

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

Parameter

req
INodeIncomingMessage

Permintaan HTTP yang cocok dengan antarmuka INodeIncomingMessage.

socket
INodeSocket

Antarmuka Socket INodeSocket.

head
INodeBuffer

Antarmuka Buffer INodeBuffer.

Mengembalikan

Promise<void>

Janji yang diselesaikan setelah peningkatan WebSocket ditangani, jika tidak, tolak dengan kesalahan yang dilemparkan.

setOnCloseHandler((x: any) => void)

Atur panggilan balik ke panggilan saat mengalami penutupan soket.

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

Parameter

handler

(x: any) => void

Panggilan balik untuk menangani peristiwa "tutup".

setOnErrorHandler((x: any) => void)

Atur panggilan balik ke panggilan saat mengalami kesalahan.

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

Parameter

handler

(x: any) => void

Panggilan balik untuk menangani peristiwa "kesalahan".

setOnMessageHandler((x: any) => void)

Atur handler untuk peristiwa 'data' dan 'message' yang diterima pada soket.

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

Parameter

handler

(x: any) => void

Panggilan balik untuk menangani peristiwa "pesan".

write(INodeBuffer)

Menulis buffer ke soket dan mengirimkannya.

function write(buffer: INodeBuffer)

Parameter

buffer
INodeBuffer

Buffer data yang akan dikirim di seluruh koneksi.