new ServerWebSocket()
Represents a server side WebSocket.
- 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
binaryMessageHandler(handler) → {WebSocketBase}
Set a binary message handler on the connection. This handler serves a similar purpose to ServerWebSocket#handler
except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated
into a single buffer before calling the handler (using WebSocketFrame#isFinal to find the boundaries).
Parameters:
Name | Type | Description |
---|---|---|
handler |
function | the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- WebSocketBase
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
end(t)
Same as WebSocketBase#end but writes some data to the stream before ending.
Parameters:
Name | Type | Description |
---|---|---|
t |
Buffer |
- Source:
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
isSsl() → {boolean}
- Source:
Returns:
true if this HttpConnection is encrypted via SSL/TLS.
- Type
- boolean
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(status)
Like ServerWebSocket#reject but with a
status
.
Parameters:
Name | Type | Description |
---|---|---|
status |
number |
- 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 by textHandlerID
.
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
textMessageHandler(handler) → {WebSocketBase}
Set a text message handler on the connection. This handler will be called similar to the
, but the buffer will be converted to a String first
Parameters:
Name | Type | Description |
---|---|---|
handler |
function | the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- WebSocketBase
uri() → {string}
- Source:
Returns:
- Type
- string
write(data) → {ServerWebSocket}
Parameters:
Name | Type | Description |
---|---|---|
data |
Buffer |
- Source:
Returns:
- Type
- ServerWebSocket
writeBinaryMessage(data) → {ServerWebSocket}
Parameters:
Name | Type | Description |
---|---|---|
data |
Buffer |
- Source:
Returns:
- Type
- ServerWebSocket
writeFinalBinaryFrame(data) → {ServerWebSocket}
Parameters:
Name | Type | Description |
---|---|---|
data |
Buffer |
- Source:
Returns:
- Type
- ServerWebSocket
writeFinalTextFrame(text) → {ServerWebSocket}
Parameters:
Name | Type | Description |
---|---|---|
text |
string |
- Source:
Returns:
- Type
- ServerWebSocket
writeFrame(frame) → {ServerWebSocket}
Parameters:
Name | Type | Description |
---|---|---|
frame |
WebSocketFrame |
- 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
writeTextMessage(text) → {WebSocketBase}
Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames
if it exceeds the maximum WebSocket frame size.
Parameters:
Name | Type | Description |
---|---|---|
text |
string | the data to write |
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- WebSocketBase