@groovy.transform.CompileStatic class WebSocketBaseImpl extends java.lang.Object
Constructor and description |
---|
WebSocketBaseImpl
(java.lang.Object delegate) |
Type | Name and description |
---|---|
java.lang.String |
binaryHandlerID() 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. |
void |
close() Close the WebSocket. |
WebSocketBase |
closeHandler(io.vertx.core.Handler<java.lang.Void> handler) Set a close handler. |
WebSocketBase |
drainHandler(io.vertx.core.Handler<java.lang.Void> handler) |
void |
end(Buffer t) Same as WebSocketBase.end but writes some data to the stream before ending. |
void |
end() Calls WebSocketBase.close |
WebSocketBase |
endHandler(io.vertx.core.Handler<java.lang.Void> endHandler) |
WebSocketBase |
exceptionHandler(io.vertx.core.Handler<java.lang.Throwable> handler) |
WebSocketBase |
frameHandler(io.vertx.core.Handler<WebSocketFrame> handler) Set a frame handler on the connection. |
java.lang.Object |
getDelegate() |
WebSocketBase |
handler(io.vertx.core.Handler<Buffer> handler) |
SocketAddress |
localAddress() @return
|
WebSocketBase |
pause() |
SocketAddress |
remoteAddress() @return
|
WebSocketBase |
resume() |
WebSocketBase |
setWriteQueueMaxSize(int maxSize) |
java.lang.String |
textHandlerID() When a Websocket is created it automatically registers an event handler with the eventbus, the ID of that
handler is given by textHandlerID . |
WebSocketBase |
write(Buffer data) |
WebSocketBase |
writeBinaryMessage(Buffer data) Writes a (potentially large) piece of binary data to the connection. |
WebSocketBase |
writeFinalBinaryFrame(Buffer data) Write a final WebSocket binary frame to the connection |
WebSocketBase |
writeFinalTextFrame(java.lang.String text) Write a final WebSocket text frame to the connection |
WebSocketBase |
writeFrame(WebSocketFrame frame) Write a WebSocket frame to the connection |
boolean |
writeQueueFull() This will return true if there are more bytes in the write queue than the value set using WebSocketBase.setWriteQueueMaxSize |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
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.
Close the WebSocket.
Set a close handler. This will be called when the WebSocket is closed.
handler
- the handlerSame as WebSocketBase.end but writes some data to the stream before ending.
Calls WebSocketBase.close
Set a frame handler on the connection. This handler will be called when frames are read on the connection.
handler
- the handler
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.
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.
data
- the data to writeWrite a final WebSocket binary frame to the connection
data
- The data to writeWrite a final WebSocket text frame to the connection
text
- The text to writeWrite a WebSocket frame to the connection
frame
- the frame to write This will return true
if there are more bytes in the write queue than the value set using WebSocketBase.setWriteQueueMaxSize