public class ServerWebSocketImpl extends WebSocketImplBase implements ServerWebSocket
closed, closeHandler, conn, dataHandler, drainHandler, endHandler, exceptionHandler, frameHandler| Constructor and Description |
|---|
ServerWebSocketImpl(VertxInternal vertx,
String uri,
String path,
String query,
MultiMap headers,
ConnectionBase conn,
boolean supportsContinuation,
Runnable connectRunnable,
int maxWebSocketFrameSize) |
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close the WebSocket.
|
ServerWebSocket |
closeHandler(Handler<Void> handler)
Set a close handler.
|
ServerWebSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
ServerWebSocket |
endHandler(Handler<Void> handler)
Set an end handler.
|
ServerWebSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
ServerWebSocket |
frameHandler(Handler<WebSocketFrame> handler)
Set a frame handler on the connection.
|
ServerWebSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
MultiMap |
headers() |
String |
path() |
ServerWebSocket |
pause()
Pause the
ReadSupport. |
X509Certificate[] |
peerCertificateChain() |
String |
query() |
void |
reject()
Reject the WebSocket.
|
ServerWebSocket |
resume()
Resume reading.
|
ServerWebSocket |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
String |
uri() |
ServerWebSocket |
write(Buffer data)
Write some data to the stream.
|
ServerWebSocket |
writeBinaryMessage(Buffer data)
Writes a (potentially large) piece of binary data to the connection.
|
ServerWebSocket |
writeFinalBinaryFrame(Buffer data)
Write a final WebSocket binary frame to the connection
|
ServerWebSocket |
writeFinalTextFrame(String text)
Write a final WebSocket text frame to the connection
|
ServerWebSocket |
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 WriteStream.setWriteQueueMaxSize(int) |
binaryHandlerID, checkClosed, localAddress, remoteAddress, textHandlerID, writeBinaryFrameInternal, writeFrameInternal, writeMessageInternal, writePartialMessage, writeTextFrameInternalclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbinaryHandlerID, localAddress, remoteAddress, textHandlerIDpublic ServerWebSocketImpl(VertxInternal vertx, String uri, String path, String query, MultiMap headers, ConnectionBase conn, boolean supportsContinuation, Runnable connectRunnable, int maxWebSocketFrameSize)
public String uri()
uri in interface ServerWebSocketpublic String path()
path in interface ServerWebSocketpublic String query()
query in interface ServerWebSocketpublic MultiMap headers()
headers in interface ServerWebSocketpublic void reject()
ServerWebSocketCalling 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.
reject in interface ServerWebSocketpublic X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException
peerCertificateChain in interface ServerWebSocketSSLPeerUnverifiedException - SSL peer's identity has not been verified.public void close()
WebSocketBaseclose in interface WebSocketBaseclose in class WebSocketImplBasepublic ServerWebSocket handler(Handler<Buffer> handler)
ReadStreamhandler in interface ServerWebSockethandler in interface WebSocketBasehandler in interface ReadStream<Buffer>public ServerWebSocket endHandler(Handler<Void> handler)
ReadStreamendHandler in interface ServerWebSocketendHandler in interface WebSocketBaseendHandler in interface ReadStream<Buffer>public ServerWebSocket exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ServerWebSocketexceptionHandler in interface WebSocketBaseexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>exceptionHandler in class WebSocketImplBasehandler - the exception handlerpublic ServerWebSocket closeHandler(Handler<Void> handler)
WebSocketBasecloseHandler in interface ServerWebSocketcloseHandler in interface WebSocketBasehandler - the handlerpublic ServerWebSocket frameHandler(Handler<WebSocketFrame> handler)
WebSocketBaseframeHandler in interface ServerWebSocketframeHandler in interface WebSocketBasehandler - the handlerpublic ServerWebSocket pause()
ReadStreamReadSupport. While it's paused, no data will be sent to the dataHandlerpause in interface ServerWebSocketpause in interface WebSocketBasepause in interface ReadStream<Buffer>public ServerWebSocket resume()
ReadStreamReadSupport has been paused, reading will recommence on it.resume in interface ServerWebSocketresume in interface WebSocketBaseresume in interface ReadStream<Buffer>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 ServerWebSocketsetWriteQueueMaxSize in interface WebSocketBasesetWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streampublic boolean writeQueueFull()
WriteStreamtrue if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int)writeQueueFull in interface WriteStream<Buffer>writeQueueFull in class WebSocketImplBasepublic ServerWebSocket write(Buffer data)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface ServerWebSocketwrite in interface WebSocketBasewrite in interface WriteStream<Buffer>data - the data to writepublic ServerWebSocket drainHandler(Handler<Void> handler)
WriteStreamPump for an example of this being used.drainHandler in interface ServerWebSocketdrainHandler in interface WebSocketBasedrainHandler in interface WriteStream<Buffer>handler - the handlerpublic ServerWebSocket writeFrame(WebSocketFrame frame)
WebSocketBasewriteFrame in interface ServerWebSocketwriteFrame in interface WebSocketBaseframe - the frame to writepublic ServerWebSocket writeFinalTextFrame(String text)
WebSocketBasewriteFinalTextFrame in interface ServerWebSocketwriteFinalTextFrame in interface WebSocketBasetext - The text to writepublic ServerWebSocket writeFinalBinaryFrame(Buffer data)
WebSocketBasewriteFinalBinaryFrame in interface ServerWebSocketwriteFinalBinaryFrame in interface WebSocketBasedata - The data to writepublic ServerWebSocket writeBinaryMessage(Buffer data)
WebSocketBasewriteBinaryMessage in interface ServerWebSocketwriteBinaryMessage in interface WebSocketBasedata - the data to writeCopyright © 2015. All Rights Reserved.