Base WebSocket implementation.
It implements both and so it can be used with Pump to pump data with flow control.
no type hierarchy
Inherited Attributes |
Attributes inherited from: Object hash , string |
Methods | |
binaryHandlerID | shared 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. |
close | shared void close() Close the WebSocket. |
closeHandler | shared WebSocketBase closeHandler(Anything()? handler) Set a close handler. This will be called when the WebSocket is closed. Parameters:
|
drainHandler | shared WebSocketBase drainHandler(Anything()? handler) |
end | shared void end() Calls close |
end | shared void end(Buffer t) Same as end but writes some data to the stream before ending. |
endHandler | shared WebSocketBase endHandler(Anything()? endHandler) |
exceptionHandler | shared WebSocketBase exceptionHandler(Anything(Throwable)? handler) |
frameHandler | shared WebSocketBase frameHandler(Anything(WebSocketFrame)? handler) Set a frame handler on the connection. This handler will be called when frames are read on the connection. Parameters:
|
handler | shared WebSocketBase handler(Anything(Buffer)? handler) |
localAddress | shared SocketAddress localAddress() @return the local address for this socket |
pause | shared WebSocketBase pause() |
remoteAddress | shared SocketAddress remoteAddress() @return the remote address for this socket |
resume | shared WebSocketBase resume() |
setWriteQueueMaxSize | shared WebSocketBase setWriteQueueMaxSize(Integer maxSize) |
textHandlerID | shared 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. |
write | shared WebSocketBase write(Buffer data) |
writeBinaryMessage | shared WebSocketBase 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. Parameters:
|
writeFinalBinaryFrame | shared WebSocketBase writeFinalBinaryFrame(Buffer data) Write a final WebSocket binary frame to the connection Parameters:
|
writeFinalTextFrame | shared WebSocketBase writeFinalTextFrame(String text) Write a final WebSocket text frame to the connection Parameters:
|
writeFrame | shared WebSocketBase writeFrame(WebSocketFrame frame) Write a WebSocket frame to the connection Parameters:
|
writeQueueFull | shared Boolean writeQueueFull() This will return |
Inherited Methods |
Methods inherited from: Object equals |
Methods inherited from: ReadStream<T> |
Methods inherited from: StreamBase |
Methods inherited from: WriteStream<T> |