Represents a server side WebSocket.
Instances of this class are passed into a websocketHandler or provided when a WebSocket handshake is manually upgradeed.
Anything
ServerWebSocket
Basic
Identifiable
Object
Anything
no subtypes hierarchy
Initializer |
ServerWebSocket(ServerWebSocket unknown) |
Inherited Attributes |
Attributes inherited from: Object hash , string |
Methods | |
binaryHandlerID | shared actual default String binaryHandlerID() When a 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. Refines WebSocketBase.binaryHandlerID |
close | shared actual default void close() Close the WebSocket. Refines WebSocketBase.close |
closeHandler | shared actual default ServerWebSocket closeHandler(Anything()? handler) Set a close handler. This will be called when the WebSocket is closed. Refines WebSocketBase.closeHandler |
drainHandler | shared actual default ServerWebSocket drainHandler(Anything()? handler) Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue has been reduced to maxSize / 2. See Pump for an example of this being used. Refines WriteStream.drainHandler |
end | shared actual default void end() Calls close Refines WriteStream.end |
end | shared actual default void end(Buffer t) Same as end but writes some data to the stream before ending. Refines WebSocketBase.end |
endHandler | shared actual default ServerWebSocket endHandler(Anything()? endHandler) Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called. Refines ReadStream.endHandler |
exceptionHandler | shared actual default ServerWebSocket exceptionHandler(Anything(Throwable)? handler) Set an exception handler. Refines StreamBase.exceptionHandler |
frameHandler | shared actual default ServerWebSocket frameHandler(Anything(WebSocketFrame)? handler) Set a frame handler on the connection. This handler will be called when frames are read on the connection. Refines WebSocketBase.frameHandler |
handler | shared actual default ServerWebSocket handler(Anything(Buffer)? handler) Set a data handler. As data is read, the handler will be called with the data. Refines ReadStream.handler |
headers | shared default MultiMap headers() @return the headers in the WebSocket handshake |
localAddress | shared actual default SocketAddress localAddress() @return the local address for this socket Refines WebSocketBase.localAddress |
path | shared default String path() @return the WebSocket handshake path. |
pause | shared actual default ServerWebSocket pause() Pause the Refines ReadStream.pause |
query | shared default String? query() @return the WebSocket handshake query string. |
reject | shared default void 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. |
remoteAddress | shared actual default SocketAddress remoteAddress() @return the remote address for this socket Refines WebSocketBase.remoteAddress |
resume | shared actual default ServerWebSocket resume() Resume reading. If the Refines ReadStream.resume |
setWriteQueueMaxSize | shared actual default ServerWebSocket setWriteQueueMaxSize(Integer maxSize) Set the maximum size of the write queue to Refines WriteStream.setWriteQueueMaxSize |
textHandlerID | shared actual default String textHandlerID() When a 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. Refines WebSocketBase.textHandlerID |
uri | shared default String uri() |
write | shared actual default ServerWebSocket write(Buffer data) Refines WebSocketBase.write |
writeBinaryMessage | shared actual default ServerWebSocket writeBinaryMessage(Buffer data) Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size. Refines WebSocketBase.writeBinaryMessage |
writeFinalBinaryFrame | shared actual default ServerWebSocket writeFinalBinaryFrame(Buffer data) Write a final WebSocket binary frame to the connection |
writeFinalTextFrame | shared actual default ServerWebSocket writeFinalTextFrame(String text) Write a final WebSocket text frame to the connection |
writeFrame | shared actual default ServerWebSocket writeFrame(WebSocketFrame frame) Write a WebSocket frame to the connection Refines WebSocketBase.writeFrame |
writeQueueFull | shared actual default Boolean writeQueueFull() This will return Refines WriteStream.writeQueueFull |
Inherited Methods |
Methods inherited from: Object equals |
Methods inherited from: ReadStream<T> |
Methods inherited from: StreamBase |
Methods inherited from: WebSocketBase binaryHandlerID() , close() , closeHandler() , drainHandler() , end() , endHandler() , exceptionHandler() , frameHandler() , handler() , localAddress() , pause() , remoteAddress() , resume() , setWriteQueueMaxSize() , textHandlerID() , write() , writeBinaryMessage() , writeFinalBinaryFrame() , writeFinalTextFrame() , writeFrame() , writeQueueFull() |
Methods inherited from: WriteStream<T> |