Поделиться через


WebSocketServer class

Сервер на основе веб-сокета, используемый в качестве транспорта потоковой передачи.

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

WebSocketServer(ISocket, RequestHandler)

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

Свойства

isConnected

Проверяет хранимую ISocket и возвращает true, если подключение сокета открыто.

Методы

disconnect()

Остановите этот сервер.

send(StreamingRequest)

Задача, используемая для отправки данных через это подключение к серверу.

start()

Используется для установления соединения, используемого этим сервером, и начинает прослушивать входящие сообщения.

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

WebSocketServer(ISocket, RequestHandler)

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

new WebSocketServer(socket: ISocket, requestHandler?: RequestHandler)

Параметры

socket
ISocket

Базовый веб-сокет.

requestHandler
RequestHandler

Необязательный RequestHandler для обработки входящих сообщений, полученных этим сервером.

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

isConnected

Проверяет хранимую ISocket и возвращает true, если подключение сокета открыто.

boolean isConnected

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

boolean

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

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

disconnect()

Остановите этот сервер.

function disconnect()

send(StreamingRequest)

Задача, используемая для отправки данных через это подключение к серверу.

function send(request: StreamingRequest): Promise<IReceiveResponse>

Параметры

request
StreamingRequest

Запрос потоковой передачи для отправки.

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

Promise<IReceiveResponse>

Обещание, которое приведет к получению экземпляра ответа при завершении операции отправки.

start()

Используется для установления соединения, используемого этим сервером, и начинает прослушивать входящие сообщения.

function start(): Promise<string>

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

Promise<string>

Обещание обработать операцию прослушивания сервера. Эта задача не будет разрешаться до тех пор, пока сервер запущен.