@groovy.transform.CompileStatic class ServerWebSocket extends java.lang.Object
Represents a server side WebSocket.
Instances of this class are passed into a HttpServer.websocketHandler or provided when a WebSocket handshake is manually HttpServerRequest.upgradeed.
Constructor and description |
---|
ServerWebSocket
(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. |
ServerWebSocket |
closeHandler(io.vertx.core.Handler<java.lang.Void> handler) |
ServerWebSocket |
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 |
ServerWebSocket |
endHandler(io.vertx.core.Handler<java.lang.Void> endHandler) |
ServerWebSocket |
exceptionHandler(io.vertx.core.Handler<java.lang.Throwable> handler) |
ServerWebSocket |
frameHandler(io.vertx.core.Handler<WebSocketFrame> handler) |
java.lang.Object |
getDelegate() |
ServerWebSocket |
handler(io.vertx.core.Handler<Buffer> handler) |
MultiMap |
headers() @return
|
SocketAddress |
localAddress() @return
|
java.lang.String |
path()
|
ServerWebSocket |
pause() |
java.lang.String |
query()
|
void |
reject() Reject the WebSocket. |
SocketAddress |
remoteAddress() @return
|
ServerWebSocket |
resume() |
ServerWebSocket |
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 . |
java.lang.String |
uri() |
ServerWebSocket |
write(Buffer data) |
ServerWebSocket |
writeBinaryMessage(Buffer data) |
ServerWebSocket |
writeFinalBinaryFrame(Buffer data) |
ServerWebSocket |
writeFinalTextFrame(java.lang.String text) |
ServerWebSocket |
writeFrame(WebSocketFrame frame) |
boolean |
writeQueueFull() This will return true if there are more bytes in the write queue than the value set using ServerWebSocket.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.
Same as WebSocketBase.end but writes some data to the stream before ending.
Calls WebSocketBase.close
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.
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.
This will return true
if there are more bytes in the write queue than the value set using ServerWebSocket.setWriteQueueMaxSize