new ServerWebSocket()
- Source:
Methods
-
binaryHandlerID() → {string}
-
When a
Websocket
is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.Given this ID, a different event loop can send a binary frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.
- Source:
Returns:
the binary handler id- Type
- string
-
close()
-
Close the WebSocket.
- Source:
-
closeHandler(handler) → {ServerWebSocket}
-
Parameters:
Name Type Description handler
function - Source:
Returns:
- Type
- ServerWebSocket
-
drainHandler(handler) → {ServerWebSocket}
-
Parameters:
Name Type Description handler
function - Source:
Returns:
- Type
- ServerWebSocket
-
endHandler(endHandler) → {ServerWebSocket}
-
Parameters:
Name Type Description endHandler
function - Source:
Returns:
- Type
- ServerWebSocket
-
exceptionHandler(handler) → {ServerWebSocket}
-
Parameters:
Name Type Description handler
function - Source:
Returns:
- Type
- ServerWebSocket
-
frameHandler(handler) → {ServerWebSocket}
-
Parameters:
Name Type Description handler
function - Source:
Returns:
- Type
- ServerWebSocket
-
handler(handler) → {ServerWebSocket}
-
Parameters:
Name Type Description handler
function - Source:
Returns:
- Type
- ServerWebSocket
-
headers() → {MultiMap}
-
- Source:
Returns:
-
the headers in the WebSocket handshake
-
- Type
- MultiMap
-
localAddress() → {SocketAddress}
-
- Source:
Returns:
-
the local address for this socket
-
- Type
- SocketAddress
-
path() → {string}
-
- Source:
Returns:
-
the WebSocket handshake path.
-
- Type
- string
-
pause() → {ServerWebSocket}
-
- Source:
Returns:
- Type
- ServerWebSocket
-
query() → {string}
-
- Source:
Returns:
-
the WebSocket handshake query string.
-
- Type
- string
-
reject()
-
Reject the WebSocket.
Calling this method from the websocket handler when it is first passed to you gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning a 404 response code.
You might use this method, if for example you only want to accept WebSockets with a particular path.
- Source:
-
remoteAddress() → {SocketAddress}
-
- Source:
Returns:
-
the remote address for this socket
-
- Type
- SocketAddress
-
resume() → {ServerWebSocket}
-
- Source:
Returns:
- Type
- ServerWebSocket
-
setWriteQueueMaxSize(maxSize) → {ServerWebSocket}
-
Parameters:
Name Type Description maxSize
number - Source:
Returns:
- Type
- ServerWebSocket
-
textHandlerID() → {string}
-
When a
Websocket
is created it automatically registers an event handler with the eventbus, the ID of that handler is given bytextHandlerID
.Given this ID, a different event loop can send a text frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.
- Source:
Returns:
- Type
- string
-
uri() → {string}
-
- Source:
Returns:
- Type
- string
-
write(data) → {ServerWebSocket}
-
Parameters:
Name Type Description data
Buffer - Source:
Returns:
- Type
- ServerWebSocket
-
writeFrame(frame) → {ServerWebSocket}
-
Parameters:
Name Type Description frame
WebSocketFrame - Source:
Returns:
- Type
- ServerWebSocket
-
writeMessage(data) → {ServerWebSocket}
-
Parameters:
Name Type Description data
Buffer - Source:
Returns:
- Type
- ServerWebSocket
-
writeQueueFull() → {boolean}
-
This will return
true
if there are more bytes in the write queue than the value set using ServerWebSocket#setWriteQueueMaxSize- Source:
Returns:
true if write queue is full- Type
- boolean