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 |
write(Buffer data)
Write some data to the stream.
|
WebSocket |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
#write(T) but with an handler called when the operation completes |
WebSocket |
writeBinaryMessage(Buffer data)
Writes a (potentially large) piece of binary data to the connection.
|
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)
Write a final WebSocket binary frame to the connection
|
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)
Write a final WebSocket text frame to the connection
|
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)
Write a WebSocket frame to the connection
|
WebSocket |
writeFrame(WebSocketFrame frame,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFrame(WebSocketFrame) but with an handler called when the operation completes |
WebSocket |
writeTextMessage(String text)
Writes a (potentially large) piece of text data 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, pongHandler, remoteAddress, sslSession, subProtocol, textHandlerID, textMessageHandler, writePing, writePong
pipe, pipeTo, pipeTo
end, end, writeQueueFull
WebSocket exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface ReadStream<Buffer>
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WebSocketBase
exceptionHandler
in interface WriteStream<Buffer>
handler
- the exception handlerWebSocket handler(Handler<Buffer> handler)
ReadStream
handler
in interface ReadStream<Buffer>
handler
in interface WebSocketBase
WebSocket pause()
ReadStream
ReadStream
, 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 WebSocketBase
WebSocket resume()
ReadStream
flowing
mode.
If the ReadStream
has been paused, reading will recommence on it.resume
in interface ReadStream<Buffer>
resume
in interface WebSocketBase
WebSocket fetch(long amount)
ReadStream
amount
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 WebSocketBase
WebSocket endHandler(Handler<Void> endHandler)
ReadStream
endHandler
in interface ReadStream<Buffer>
endHandler
in interface WebSocketBase
WebSocket write(Buffer data)
WriteStream
WriteStream.writeQueueFull()
method before writing. This is done automatically if using a Pump
.write
in interface WebSocketBase
write
in interface WriteStream<Buffer>
data
- the data to writeWebSocket write(Buffer data, Handler<AsyncResult<Void>> handler)
WriteStream
#write(T)
but with an handler
called when the operation completeswrite
in interface WebSocketBase
write
in interface WriteStream<Buffer>
WebSocket setWriteQueueMaxSize(int maxSize)
WriteStream
maxSize
. 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
Pump
to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket
, the number of Message
for a
MessageProducer
, etc...setWriteQueueMaxSize
in interface WebSocketBase
setWriteQueueMaxSize
in interface WriteStream<Buffer>
maxSize
- the max size of the write streamWebSocket drainHandler(Handler<Void> handler)
WriteStream
Pump
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 WebSocketBase
drainHandler
in interface WriteStream<Buffer>
handler
- the handlerWebSocket writeFrame(WebSocketFrame frame)
WebSocketBase
writeFrame
in interface WebSocketBase
frame
- the frame to writeWebSocket writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
WebSocketBase
WebSocketBase.writeFrame(WebSocketFrame)
but with an handler
called when the operation completeswriteFrame
in interface WebSocketBase
WebSocket writeFinalTextFrame(String text)
WebSocketBase
writeFinalTextFrame
in interface WebSocketBase
text
- The text to writeWebSocket writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
WebSocketBase
WebSocketBase.writeFinalTextFrame(String, Handler)
but with an handler
called when the operation completeswriteFinalTextFrame
in interface WebSocketBase
WebSocket writeFinalBinaryFrame(Buffer data)
WebSocketBase
writeFinalBinaryFrame
in interface WebSocketBase
data
- The data to writeWebSocket writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBase
WebSocketBase.writeFinalBinaryFrame(Buffer, Handler)
but with an handler
called when the operation completeswriteFinalBinaryFrame
in interface WebSocketBase
WebSocket writeBinaryMessage(Buffer data)
WebSocketBase
writeBinaryMessage
in interface WebSocketBase
data
- the data to writeWebSocket writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBase
WebSocketBase.writeBinaryMessage(Buffer)
but with an handler
called when the operation completeswriteBinaryMessage
in interface WebSocketBase
WebSocket writeTextMessage(String text)
WebSocketBase
writeTextMessage
in interface WebSocketBase
text
- the data to writeWebSocket writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
WebSocketBase
WebSocketBase.writeTextMessage(String)
but with an handler
called when the operation completeswriteTextMessage
in interface WebSocketBase
WebSocket closeHandler(Handler<Void> handler)
WebSocketBase
WebSocketBase.closeStatusCode()
will return the status code and WebSocketBase.closeReason()
will return the reason.closeHandler
in interface WebSocketBase
handler
- the handlerWebSocket frameHandler(Handler<WebSocketFrame> handler)
WebSocketBase
frameHandler
in interface WebSocketBase
handler
- the handlerCopyright © 2023 Eclipse. All rights reserved.