WebSocketServer class
Websocketbasierter Server, der als Streamingtransport verwendet werden soll.
Konstruktoren
Web |
Erstellt eine neue Instanz der WebSocketServer Klasse. |
Eigenschaften
is |
Überprüft das gespeicherte ISocket- und gibt |
Methoden
disconnect() | Beenden Sie diesen Server. |
send(Streaming |
Aufgabe, die zum Senden von Daten über diese Serververbindung verwendet wird. |
start() | Wird verwendet, um die von diesem Server verwendete Verbindung herzustellen und mit der Überwachung eingehender Nachrichten zu beginnen. |
Details zum Konstruktor
WebSocketServer(ISocket, RequestHandler)
Erstellt eine neue Instanz der WebSocketServer Klasse.
new WebSocketServer(socket: ISocket, requestHandler?: RequestHandler)
Parameter
- socket
- ISocket
Der zugrunde liegende Websocket.
- requestHandler
- RequestHandler
Optionaler RequestHandler zum Verarbeiten eingehender Nachrichten, die von diesem Server empfangen werden.
Details zur Eigenschaft
isConnected
Überprüft das gespeicherte ISocket- und gibt true
zurück, wenn die Socketverbindung geöffnet ist.
boolean isConnected
Eigenschaftswert
boolean
true
, wenn das zugrunde liegende Websocket bereit und verfügbar ist, um Nachrichten zu senden, andernfalls false
.
Details zur Methode
disconnect()
Beenden Sie diesen Server.
function disconnect()
send(StreamingRequest)
Aufgabe, die zum Senden von Daten über diese Serververbindung verwendet wird.
function send(request: StreamingRequest): Promise<IReceiveResponse>
Parameter
- request
- StreamingRequest
Die zu sendende Streaminganforderung.
Gibt zurück
Promise<IReceiveResponse>
Eine Zusage, die eine Instanz der Empfangsantwort nach Abschluss des Sendevorgangs erzeugt.
start()
Wird verwendet, um die von diesem Server verwendete Verbindung herzustellen und mit der Überwachung eingehender Nachrichten zu beginnen.
function start(): Promise<string>
Gibt zurück
Promise<string>
Eine Zusage zum Behandeln des Server-Listenvorgangs. Diese Aufgabe wird nicht aufgelöst, solange der Server ausgeführt wird.