NodeWebSocket class

Пакет:

botframework-streaming

Реализация ISocket для использования с NodeWebSocketFactory для создания сервера WebSocket.

Конструкторы

NodeWebSocket(WebSocket)

Создает новый экземпляр NodeWebSocket.

Свойства

isConnected

Указывает, подключен ли веб-сайт WSocket и готов к отправке сообщений.

Методы

close(number, string)	Закройте сокет.
connect(string, number)	Подключается к вспомогательному сокету с помощью протокола WebSocket.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)	Создайте и задайте ws WebSocket с помощью HTTP-запроса, сокета и буфера.
setOnCloseHandler((x: any) => void)	Задайте обратный вызов при обнаружении закрытия сокета.
setOnErrorHandler((x: any) => void)	Задайте обратный вызов при возникновении ошибок.
setOnMessageHandler((x: any) => void)	Задайте обработчик для 'data' и 'message' событий, полученных в сокете.
write(INodeBuffer)	Записывает буфер в сокет и отправляет его.

Сведения о конструкторе

NodeWebSocket(WebSocket)

Создает новый экземпляр NodeWebSocket.

new NodeWebSocket(wsSocket?: WebSocket)

Параметры

wsSocket

WebSocket

Экземпляр ws WebSocket для сборки этого подключения.

Сведения о свойстве

isConnected

Указывает, подключен ли веб-сайт WSocket и готов к отправке сообщений.

boolean isConnected

Значение свойства

boolean

true, если базовый websocket готов и доступен для отправки сообщений, в противном случае false.

Сведения о методе

close(number, string)

Закройте сокет.

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

Параметры

code

number

Необязательный код состояния, чтобы объяснить, почему подключение закрыто.

data

string

Необязательные дополнительные данные, чтобы объяснить, почему подключение закрыто.

Комментарии

При необходимости передайте код состояния и строку, объясняя, почему соединение закрывается.

connect(string, number)

Подключается к вспомогательному сокету с помощью протокола WebSocket.

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

Параметры

serverAddress

string

Адрес сервера прослушивается.

port

number

Порт, на который сервер прослушивается, по умолчанию используется значение 8082.

Возвращаемое значение

Promise<void>

Обещание, которое разрешается при закрытии подключения websocket или отклонении ошибки.

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

Создайте и задайте ws WebSocket с помощью HTTP-запроса, сокета и буфера.

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

Параметры

req

INodeIncomingMessage

HTTP-запрос, соответствующий интерфейсу INodeIncomingMessage.

socket

INodeSocket

Интерфейс INodeSocket сокетом .

head

INodeBuffer

Интерфейс буфера INodeBuffer.

Возвращаемое значение

Promise<void>

Обещание, разрешающее после обработки обновления WebSocket, в противном случае отклоняется с ошибкой, вызванной ошибкой.

setOnCloseHandler((x: any) => void)

Задайте обратный вызов при обнаружении закрытия сокета.

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

Параметры

handler

(x: any) => void

Обратный вызов для обработки события close.

setOnErrorHandler((x: any) => void)

Задайте обратный вызов при возникновении ошибок.

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

Параметры

handler

(x: any) => void

Обратный вызов для обработки события error.

setOnMessageHandler((x: any) => void)

Задайте обработчик для 'data' и 'message' событий, полученных в сокете.

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

Параметры

handler

(x: any) => void

Обратный вызов для обработки события message.

write(INodeBuffer)

Записывает буфер в сокет и отправляет его.

function write(buffer: INodeBuffer)

Параметры

buffer

INodeBuffer

Буфер данных для отправки по подключению.