public interface WebSocket extends WebSocketBase
| Modifier and Type | Method and Description |
|---|---|
WebSocket |
closeHandler(Handler<Void> handler)
Set a close handler.
|
WebSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
WebSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
WebSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
WebSocket |
fetch(long amount)
Fetch the specified
amount of elements. |
WebSocket |
frameHandler(Handler<WebSocketFrame> handler)
Set a frame handler on the connection.
|
WebSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
WebSocket |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
WebSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
WebSocket |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
WebSocket |
writeBinaryMessage(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeBinaryMessage(Buffer) but with an handler called when the operation completes |
WebSocket |
writeFinalBinaryFrame(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFinalBinaryFrame(Buffer, Handler) but with an handler called when the operation completes |
WebSocket |
writeFinalTextFrame(String text,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFinalTextFrame(String, Handler) but with an handler called when the operation completes |
WebSocket |
writeFrame(WebSocketFrame frame,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFrame(WebSocketFrame) but with an handler called when the operation completes |
WebSocket |
writePing(Buffer data,
Handler<AsyncResult<Void>> handler)
Writes a ping frame to the connection.
|
WebSocket |
writePong(Buffer data,
Handler<AsyncResult<Void>> handler)
Writes a pong frame to the connection.
|
WebSocket |
writeTextMessage(String text,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeTextMessage(String) but with an handler called when the operation completes |
binaryHandlerID, binaryMessageHandler, close, close, close, close, close, close, closeReason, closeStatusCode, end, end, headers, isClosed, isSsl, localAddress, peerCertificateChain, peerCertificates, pongHandler, remoteAddress, sslSession, subProtocol, textHandlerID, textMessageHandler, writeBinaryMessage, writeFinalBinaryFrame, writeFinalTextFrame, writeFrame, writePing, writePong, writeTextMessagecollect, pipe, pipeTo, pipeToend, end, write, write, writeQueueFullWebSocket exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WebSocketBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerWebSocket handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>handler in interface WebSocketBaseWebSocket pause()
ReadStreamReadStream, it sets the buffer in fetch mode and clears the actual demand.
While it's paused, no data will be sent to the data handler.
pause in interface ReadStream<Buffer>pause in interface WebSocketBaseWebSocket resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>resume in interface WebSocketBaseWebSocket fetch(long amount)
ReadStreamamount of elements. If the ReadStream has been paused, reading will
recommence with the specified amount of items, otherwise the specified amount will
be added to the current stream demand.fetch in interface ReadStream<Buffer>fetch in interface WebSocketBaseWebSocket endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>endHandler in interface WebSocketBaseWebSocket setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. You will still be able to write to the stream even
if there is more than maxSize items in the write queue. This is used as an indicator by classes such as
Pipe to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, etc...setWriteQueueMaxSize in interface WebSocketBasesetWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streamWebSocket drainHandler(Handler<Void> handler)
WriteStreamPipe for an example of this being used.
The stream implementation defines when the drain handler, for example it could be when the queue size has been
reduced to maxSize / 2.
drainHandler in interface WebSocketBasedrainHandler in interface WriteStream<Buffer>handler - the handlerWebSocket writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFrame(WebSocketFrame) but with an handler called when the operation completeswriteFrame in interface WebSocketBaseWebSocket writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFinalTextFrame(String, Handler) but with an handler called when the operation completeswriteFinalTextFrame in interface WebSocketBaseWebSocket writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFinalBinaryFrame(Buffer, Handler) but with an handler called when the operation completeswriteFinalBinaryFrame in interface WebSocketBaseWebSocket writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeBinaryMessage(Buffer) but with an handler called when the operation completeswriteBinaryMessage in interface WebSocketBaseWebSocket writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeTextMessage(String) but with an handler called when the operation completeswriteTextMessage in interface WebSocketBaseWebSocket writePing(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseThis method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.
There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.
writePing in interface WebSocketBasedata - the data to write, may be at most 125 byteshandler - called when the ping frame has been successfully writtenWebSocket writePong(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseThis method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.
There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.
writePong in interface WebSocketBasedata - the data to write, may be at most 125 byteshandler - called when the pong frame has been successfully writtenWebSocket closeHandler(Handler<Void> handler)
WebSocketBaseWebSocketBase.closeStatusCode() will return the status code and WebSocketBase.closeReason() will return the reason.closeHandler in interface WebSocketBasehandler - the handlerWebSocket frameHandler(Handler<WebSocketFrame> handler)
WebSocketBaseframeHandler in interface WebSocketBasehandler - the handlerCopyright © 2024 Eclipse. All rights reserved.