Accept the WebSocket and terminate the WebSocket handshake.
This method should be called from the WebSocket handler to explicitly accept the WebSocket and terminate the WebSocket handshake.When a WebSocket is created, it may register an event handler with the event bus - the ID of that
handler is given by this method.
By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions or HttpServerOptions.
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.
Set a binary message handler on the connection. This handler serves a similar purpose to {@link 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 {@link WebSocketFrame#isFinal} to find the boundaries).
Same as {@link ServerWebSocket#close} but with an handler called when the operation completes
Same as {@link ServerWebSocket#close} but with an handler called when the operation completes
Same as {@link WebSocketBase#close} but with an handler called when the operation completes
Same as {@link WebSocketBase#close} but with an handler called when the operation completes
Same as {@link WebSocketBase#close} but with an handler called when the operation completes
Same as {@link WebSocketBase#close} but with an handler called when the operation completes
Returns the close reason message from the remote endpoint or null when not yet received.
Returns the close status code received from the remote endpoint or null when not yet received.
Same as but with an handler called when the operation completes
Same as but with an handler called when the operation completes
Calls {@link WebSocketBase#close}
Calls {@link WebSocketBase#close}
Returns the HTTP headers when the WebSocket is first obtained in the handler.
The headers will benull on subsequent interactions.
Pipe this ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
Pipe this ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
Set a pong frame handler on the connection. This handler will be invoked every time a pong frame is received on the server, and can be used by both clients and servers since the RFC 6455 section 5.5.2 and section 5.5.3 do not specify whether the client or server sends a ping.
Pong frames may be at most 125 bytes (octets).
There is no ping handler since ping frames should immediately be responded to with a pong frame with identical content
Pong frames may be received unsolicited.
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 response code.
You might use this method, if for example you only want to accept WebSockets with a particular path.
Like {@link ServerWebSocket#reject} but with a status.
Set an asynchronous result for the handshake, upon completion of the specified future, the
WebSocket will either be
future succeeds with the HTTP status codefuture is succeeds with an HTTP status code different than future fails with the HTTP status code 500The provided future might be completed by the WebSocket itself, e.g calling the {@link ServerWebSocket#close} method
will try to accept the handshake and close the WebSocket afterward. Thus it is advised to try to complete
the future with or .
This method should be called from the WebSocket handler to explicitly set an asynchronous handshake.
Calling this method will override the future completion handler.
Set an asynchronous result for the handshake, upon completion of the specified future, the
WebSocket will either be
future succeeds with the HTTP status codefuture is succeeds with an HTTP status code different than future fails with the HTTP status code 500The provided future might be completed by the WebSocket itself, e.g calling the {@link ServerWebSocket#close} method
will try to accept the handshake and close the WebSocket afterward. Thus it is advised to try to complete
the future with or .
This method should be called from the WebSocket handler to explicitly set an asynchronous handshake.
Calling this method will override the future completion handler.
Returns the WebSocket sub protocol selected by the WebSocket handshake.
On the server, the value will benull when the handler receives the WebSocket callback as the
handshake will not be completed yet.
When a WebSocket is created, it may register an event handler with the eventbus, the ID of that
handler is given by textHandlerID.
By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions or HttpServerOptions.
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.
Set a text message handler on the connection. This handler will be called similar to the {@link WebSocketBase#binaryMessageHandler}, but the buffer will be converted to a String first
Same as but with an handler called when the operation completes
Same as but with an handler called when the operation completes
Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).
This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.
There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.
Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).
This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.
There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.
Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).
This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.
There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.
Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).
This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.
There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.
This will return true if there are more bytes in the write queue than the value set using {@link ServerWebSocket#setWriteQueueMaxSize}
Generated using TypeDoc
Represents a server side WebSocket.
Instances of this class are passed into a {@link HttpServer#webSocketHandler} or provided when a WebSocket handshake is manually {@link HttpServerRequest#toWebSocket}ed.