NodeWebSocket class
Eine Implementierung von ISocket- zur Verwendung mit einem NodeWebSocketFactory- zum Erstellen eines WebSocket-Servers.
Konstruktoren
| Node |
Erstellt eine neue NodeWebSocket Instanz. |
Eigenschaften
| is |
Gibt an, ob das WebSocket "ws" derzeit verbunden ist und zum Senden von Nachrichten bereit ist. |
Methoden
| close(number, string) | Schließen Sie den Socket. |
| connect(string, number) | Stellt eine Verbindung mit dem unterstützenden Socket mithilfe des WebSocket-Protokolls hergestellt. |
| create(INode |
Erstellen und Festlegen eines |
| set |
Legen Sie den Rückruf fest, der beim Auftreten von Socketschließungen aufgerufen wird. |
| set |
Legen Sie den Rückruf fest, der beim Auftreten von Fehlern aufgerufen werden soll. |
| set |
Legen Sie den Handler für |
| write(INode |
Schreibt einen Puffer in den Socket und sendet ihn. |
Details zum Konstruktor
NodeWebSocket(WebSocket)
Erstellt eine neue NodeWebSocket Instanz.
new NodeWebSocket(wsSocket?: WebSocket)Parameter
- wsSocket
-
WebSocket
Die ws WebSocket-Instanz, auf der diese Verbindung erstellt werden soll.
Details zur Eigenschaft
isConnected
Gibt an, ob das WebSocket "ws" derzeit verbunden ist und zum Senden von Nachrichten bereit ist.
boolean isConnectedEigenschaftswert
boolean
true, wenn das zugrunde liegende Websocket bereit und verfügbar ist, um Nachrichten zu senden, andernfalls false.
Details zur Methode
close(number, string)
Schließen Sie den Socket.
function close(code?: number, data?: string)Parameter
- code
-
number
Optionaler Statuscode, um zu erläutern, warum die Verbindung geschlossen wurde.
- data
-
string
Optionale zusätzliche Daten, um zu erläutern, warum die Verbindung geschlossen wurde.
Hinweise
Übergeben Sie optional einen Statuscode und eine Zeichenfolge, die erläutert, warum die Verbindung geschlossen wird.
connect(string, number)
Stellt eine Verbindung mit dem unterstützenden Socket mithilfe des WebSocket-Protokolls hergestellt.
function connect(serverAddress: string, port?: number): Promise<void>Parameter
- serverAddress
-
string
Die Adresse, auf der der Server lauscht.
- port
-
number
Der Port, auf dem der Server lauscht, ist standardmäßig auf 8082 festgelegt.
Gibt zurück
Promise<void>
Eine Zusage, die aufgelöst wird, wenn die Websocket-Verbindung geschlossen wird, oder lehnt einen Fehler ab.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)
Erstellen und Festlegen eines ws WebSocket mit einer HTTP-Anforderung, Socket und Puffer.
function create(req: INodeIncomingMessage, socket: INodeSocket, head: INodeBuffer): Promise<void>Parameter
Eine HTTP-Anforderung, die mit der INodeIncomingMessage Schnittstelle abgleicht.
- socket
- INodeSocket
Eine Socket-INodeSocket- Schnittstelle.
- head
- INodeBuffer
Eine Puffer-INodeBuffer-schnittstelle.
Gibt zurück
Promise<void>
Eine Zusage, die nach der Behandlung des WebSocket-Upgrades aufgelöst wird, andernfalls wird ein ausgelöster Fehler abgelehnt.
setOnCloseHandler((x: any) => void)
Legen Sie den Rückruf fest, der beim Auftreten von Socketschließungen aufgerufen wird.
function setOnCloseHandler(handler: (x: any) => void)Parameter
- handler
-
(x: any) => void
Der Rückruf zum Behandeln des "close"-Ereignisses.
setOnErrorHandler((x: any) => void)
Legen Sie den Rückruf fest, der beim Auftreten von Fehlern aufgerufen werden soll.
function setOnErrorHandler(handler: (x: any) => void)Parameter
- handler
-
(x: any) => void
Der Rückruf zum Behandeln des "error"-Ereignisses.
setOnMessageHandler((x: any) => void)
Legen Sie den Handler für 'data'- und 'message' Ereignisse fest, die im Socket empfangen werden.
function setOnMessageHandler(handler: (x: any) => void)Parameter
- handler
-
(x: any) => void
Der Rückruf zum Behandeln des "message"-Ereignisses.
write(INodeBuffer)
Schreibt einen Puffer in den Socket und sendet ihn.
function write(buffer: INodeBuffer)Parameter
- buffer
- INodeBuffer
Der Puffer der Daten, die über die Verbindung gesendet werden sollen.