NodeWebSocket class
Eine Implementierung von ISocket , die mit einer NodeWebSocketFactory zum Erstellen eines WebSocket-Servers verwendet werden soll.
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 mithilfe des WebSocket-Protokolls eine Verbindung mit dem unterstützenden Socket her. |
| create(INode |
Erstellen und Festlegen eines |
| set |
Legen Sie den Rückruf so fest, dass er aufruft, wenn Socketschließungen auftreten. |
| set |
Legen Sie den Rückruf so fest, dass er aufruft, wenn Fehler auftreten. |
| 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 zum Senden von Nachrichten bereit und verfügbar ist, 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 erklären, warum die Verbindung geschlossen wurde.
- data
-
string
Optional zusätzliche Daten, um zu erklären, warum die Verbindung geschlossen wurde.
Hinweise
Geben Sie optional einen Statuscode und eine Zeichenfolge ein, die erklären, warum die Verbindung geschlossen wird.
connect(string, number)
Stellt mithilfe des WebSocket-Protokolls eine Verbindung mit dem unterstützenden Socket her.
function connect(serverAddress: string, port?: number): Promise<void>Parameter
- serverAddress
-
string
Die Adresse, an der der Server lauscht.
- port
-
number
Der Port, an dem der Server lauscht, ist standardmäßig 8082.
Gibt zurück
Promise<void>
Eine Zusage, die aufgelöst wird, wenn die Websocketverbindung geschlossen wird oder bei einem Fehler abgelehnt wird.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)
Erstellen und Festlegen eines ws WebSockets mit HTTP-Anforderung, Socket und Puffer.
function create(req: INodeIncomingMessage, socket: INodeSocket, head: INodeBuffer): Promise<void>Parameter
Eine HTTP-Anforderung, die der INodeIncomingMessage-Schnittstelle entspricht.
- socket
- INodeSocket
- head
- INodeBuffer
Gibt zurück
Promise<void>
Eine Zusage, die aufgelöst wird, nachdem das WebSocket-Upgrade verarbeitet wurde, andernfalls mit einem ausgelösten Fehler abgelehnt wird.
setOnCloseHandler((x: any) => void)
Legen Sie den Rückruf so fest, dass er aufruft, wenn Socketschließungen auftreten.
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 so fest, dass er aufruft, wenn Fehler auftreten.
function setOnErrorHandler(handler: (x: any) => void)Parameter
- handler
-
(x: any) => void
Der Rückruf zum Behandeln des Fehlerereignisses.
setOnMessageHandler((x: any) => void)
Legen Sie den Handler für 'data' ereignisse und 'message' fest, die im Socket empfangen werden.
function setOnMessageHandler(handler: (x: any) => void)Parameter
- handler
-
(x: any) => void
Der Rückruf, um das Ereignis "Message" zu behandeln.
write(INodeBuffer)
Schreibt einen Puffer in den Socket und sendet ihn.
function write(buffer: INodeBuffer)Parameter
- buffer
- INodeBuffer
Der Puffer von Daten, die über die Verbindung gesendet werden sollen.