public class DefaultServerWebSocket extends WebSocketImplBase implements ServerWebSocket
binaryHandler, closed, closeHandler, conn, dataHandler, drainHandler, endHandler, exceptionHandler, textHandler| Constructor and Description |
|---|
DefaultServerWebSocket(VertxInternal vertx,
java.lang.String path,
java.lang.String query,
MultiMap headers,
ConnectionBase conn,
java.lang.Runnable connectRunnable) |
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close the websocket
|
ServerWebSocket |
closeHandler(Handler<java.lang.Void> handler)
Set a closed handler on the connection
|
ServerWebSocket |
dataHandler(Handler<Buffer> handler)
Set a data handler.
|
ServerWebSocket |
drainHandler(Handler<java.lang.Void> handler)
Set a drain handler on the stream.
|
ServerWebSocket |
endHandler(Handler<java.lang.Void> handler)
Set an end handler.
|
ServerWebSocket |
exceptionHandler(Handler<java.lang.Throwable> handler)
Set an exception handler.
|
MultiMap |
headers()
A map of all headers in the request to upgrade to websocket
|
java.lang.String |
path()
The path the websocket is attempting to connect at
|
ServerWebSocket |
pause()
Pause the
ReadStream. |
java.lang.String |
query()
The query string passed on the websocket uri
|
ServerWebSocket |
reject()
Reject the WebSocket
|
ServerWebSocket |
resume()
Resume reading.
|
ServerWebSocket |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
ServerWebSocket |
write(Buffer data)
Write some data to the stream.
|
ServerWebSocket |
writeBinaryFrame(Buffer data)
Write
data to the websocket as a binary frame |
protected void |
writeFrame(WebSocketFrame frame) |
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int) |
ServerWebSocket |
writeTextFrame(java.lang.String str)
Write
str to the websocket as a text frame |
binaryHandlerID, checkClosed, textHandlerID, writeBinaryFrameInternal, writeTextFrameInternalclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbinaryHandlerID, textHandlerIDpublic DefaultServerWebSocket(VertxInternal vertx, java.lang.String path, java.lang.String query, MultiMap headers, ConnectionBase conn, java.lang.Runnable connectRunnable)
public java.lang.String path()
ServerWebSocketpath in interface ServerWebSocketpublic java.lang.String query()
ServerWebSocketquery in interface ServerWebSocketpublic MultiMap headers()
ServerWebSocketheaders in interface ServerWebSocketpublic ServerWebSocket reject()
ServerWebSocketCalling this method from the websocketHandler 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.
reject in interface ServerWebSocketpublic void close()
WebSocketBaseclose in interface WebSocketBase<ServerWebSocket>close in class WebSocketImplBasepublic ServerWebSocket dataHandler(Handler<Buffer> handler)
ReadStreamdataHandler in interface ReadStream<ServerWebSocket>public ServerWebSocket endHandler(Handler<java.lang.Void> handler)
ReadStreamendHandler in interface ReadStream<ServerWebSocket>public ServerWebSocket exceptionHandler(Handler<java.lang.Throwable> handler)
ExceptionSupportexceptionHandler in interface ExceptionSupport<ServerWebSocket>public ServerWebSocket closeHandler(Handler<java.lang.Void> handler)
WebSocketBasecloseHandler in interface WebSocketBase<ServerWebSocket>public ServerWebSocket pause()
ReadStreamReadStream. While the stream is paused, no data will be sent to the dataHandlerpause in interface ReadStream<ServerWebSocket>public ServerWebSocket resume()
ReadStreamReadStream has been paused, reading will recommence on it.resume in interface ReadStream<ServerWebSocket>public ServerWebSocket setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. You will still be able to write to the stream even
if there is more than maxSize bytes in the write queue. This is used as an indicator by classes such as
Pump to provide flow control.setWriteQueueMaxSize in interface WriteStream<ServerWebSocket>public boolean writeQueueFull()
WriteStreamtrue if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int)writeQueueFull in interface WriteStream<ServerWebSocket>writeQueueFull in class WebSocketImplBasepublic ServerWebSocket write(Buffer data)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface WriteStream<ServerWebSocket>public ServerWebSocket drainHandler(Handler<java.lang.Void> handler)
WriteStreamPump for an example of this being used.drainHandler in interface WriteStream<ServerWebSocket>public ServerWebSocket writeBinaryFrame(Buffer data)
WebSocketBasedata to the websocket as a binary framewriteBinaryFrame in interface WebSocketBase<ServerWebSocket>public ServerWebSocket writeTextFrame(java.lang.String str)
WebSocketBasestr to the websocket as a text framewriteTextFrame in interface WebSocketBase<ServerWebSocket>protected void writeFrame(WebSocketFrame frame)
writeFrame in class WebSocketImplBase