public class WebSocket extends Object implements WebSocketBase
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<WebSocket> |
__TYPE_ARG |
Constructor and Description |
---|
WebSocket(Object delegate) |
WebSocket(WebSocket delegate) |
Modifier and Type | Method and Description |
---|---|
String |
binaryHandlerID()
When a
WebSocket is created, it may register an event handler with the event bus - the ID of that
handler is given by this method. |
WebSocketBase |
binaryMessageHandler(Handler<Buffer> handler)
Set a binary message handler on the connection.
|
Completable |
close()
Same as
WebSocketBase.close() but with an handler called when the operation completes |
Completable |
close(short statusCode)
Same as
WebSocketBase.close() but with an handler called when the operation completes |
Completable |
close(short statusCode,
String reason)
Same as
WebSocketBase.close() but with an handler called when the operation completes |
WebSocket |
closeHandler(Handler<Void> handler)
Set a close handler.
|
String |
closeReason()
Returns the close reason message from the remote endpoint or
null when not yet received. |
Short |
closeStatusCode()
Returns the close status code received from the remote endpoint or
null when not yet received. |
WebSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
Completable |
end()
Calls
WebSocketBase.close() |
Completable |
end(Buffer data)
Same as but with an
handler called when the operation completes |
WebSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
boolean |
equals(Object o) |
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 |
getDelegate() |
WebSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
int |
hashCode() |
MultiMap |
headers()
Returns the HTTP headers when the WebSocket is first obtained in the handler.
|
boolean |
isClosed() |
boolean |
isSsl() |
SocketAddress |
localAddress() |
static WebSocket |
newInstance(WebSocket arg) |
WebSocket |
pause()
Pause the
ReadStream , it sets the buffer in fetch mode and clears the actual demand. |
Pipe<Buffer> |
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .
|
Completable |
pipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream . |
WebSocketBase |
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.
|
SocketAddress |
remoteAddress() |
WebSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
Completable |
rxClose()
Same as
WebSocketBase.close() but with an handler called when the operation completes |
Completable |
rxClose(short statusCode)
Same as
WebSocketBase.close() but with an handler called when the operation completes |
Completable |
rxClose(short statusCode,
String reason)
Same as
WebSocketBase.close() but with an handler called when the operation completes |
Completable |
rxEnd()
Calls
WebSocketBase.close() |
Completable |
rxEnd(Buffer data)
Same as but with an
handler called when the operation completes |
Completable |
rxPipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream . |
Completable |
rxWrite(Buffer data)
Same as but with an
handler called when the operation completes |
Completable |
rxWriteBinaryMessage(Buffer data)
Same as
WebSocketBase.writeBinaryMessage(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completes |
Completable |
rxWriteFinalBinaryFrame(Buffer data)
Same as
WebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completes |
Completable |
rxWriteFinalTextFrame(String text)
Same as
WebSocketBase.writeFinalTextFrame(java.lang.String) but with an handler called when the operation completes |
Completable |
rxWriteFrame(WebSocketFrame frame)
Same as
WebSocketBase.writeFrame(io.vertx.rxjava3.core.http.WebSocketFrame) but with an handler called when the operation completes |
Completable |
rxWritePing(Buffer data)
Writes a ping frame to the connection.
|
Completable |
rxWritePong(Buffer data)
Writes a pong frame to the connection.
|
Completable |
rxWriteTextMessage(String text)
Same as
WebSocketBase.writeTextMessage(java.lang.String) but with an handler called when the operation completes |
WebSocket |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize . |
SSLSession |
sslSession() |
String |
subProtocol()
Returns the WebSocket sub protocol selected by the WebSocket handshake.
|
String |
textHandlerID()
When a
WebSocket is created, it may register an event handler with the eventbus, the ID of that
handler is given by textHandlerID . |
WebSocketBase |
textMessageHandler(Handler<String> handler)
Set a text message handler on the connection.
|
Flowable<Buffer> |
toFlowable() |
Observable<Buffer> |
toObservable() |
WriteStreamObserver<Buffer> |
toObserver() |
String |
toString() |
WriteStreamSubscriber<Buffer> |
toSubscriber() |
Completable |
write(Buffer data)
Same as but with an
handler called when the operation completes |
Completable |
writeBinaryMessage(Buffer data)
Same as
WebSocketBase.writeBinaryMessage(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completes |
Completable |
writeFinalBinaryFrame(Buffer data)
Same as
WebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completes |
Completable |
writeFinalTextFrame(String text)
Same as
WebSocketBase.writeFinalTextFrame(java.lang.String) but with an handler called when the operation completes |
Completable |
writeFrame(WebSocketFrame frame)
Same as
WebSocketBase.writeFrame(io.vertx.rxjava3.core.http.WebSocketFrame) but with an handler called when the operation completes |
Completable |
writePing(Buffer data)
Writes a ping frame to the connection.
|
Completable |
writePong(Buffer data)
Writes a pong frame to the connection.
|
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int) |
Completable |
writeTextMessage(String text)
Same as
WebSocketBase.writeTextMessage(java.lang.String) but with an handler called when the operation completes |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
newInstance
newInstance, newInstance
newInstance, newInstance
newInstance
public static final io.vertx.lang.rx.TypeArg<WebSocket> __TYPE_ARG
public WebSocket(WebSocket delegate)
public WebSocket(Object delegate)
public WebSocket getDelegate()
getDelegate
in interface WebSocketBase
getDelegate
in interface ReadStream<Buffer>
getDelegate
in interface StreamBase
getDelegate
in interface WriteStream<Buffer>
public Observable<Buffer> toObservable()
toObservable
in interface ReadStream<Buffer>
public Flowable<Buffer> toFlowable()
toFlowable
in interface ReadStream<Buffer>
public WriteStreamObserver<Buffer> toObserver()
public WriteStreamSubscriber<Buffer> toSubscriber()
public Pipe<Buffer> pipe()
WriteStream
.pipe
in interface WebSocketBase
pipe
in interface ReadStream<Buffer>
public Completable pipeTo(WriteStream<Buffer> dst)
ReadStream
to the WriteStream
.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler
will be
called with the result.
pipeTo
in interface WebSocketBase
pipeTo
in interface ReadStream<Buffer>
dst
- the destination write streampublic Completable rxPipeTo(WriteStream<Buffer> dst)
ReadStream
to the WriteStream
.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler
will be
called with the result.
rxPipeTo
in interface WebSocketBase
rxPipeTo
in interface ReadStream<Buffer>
dst
- the destination write streampublic Completable write(Buffer data)
handler
called when the operation completeswrite
in interface WebSocketBase
write
in interface WriteStream<Buffer>
data
- public Completable rxWrite(Buffer data)
handler
called when the operation completesrxWrite
in interface WebSocketBase
rxWrite
in interface WriteStream<Buffer>
data
- public Completable end(Buffer data)
handler
called when the operation completesend
in interface WebSocketBase
end
in interface WriteStream<Buffer>
data
- public Completable rxEnd(Buffer data)
handler
called when the operation completesrxEnd
in interface WebSocketBase
rxEnd
in interface WriteStream<Buffer>
data
- public boolean writeQueueFull()
true
if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)
writeQueueFull
in interface WebSocketBase
writeQueueFull
in interface WriteStream<Buffer>
true
if write queue is fullpublic String binaryHandlerID()
WebSocket
is created, it may register an event handler with the event bus - the ID of that
handler is given by this method.
By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions
or HttpServerOptions
.
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.
binaryHandlerID
in interface WebSocketBase
public String textHandlerID()
WebSocket
is created, it may register an event handler with the eventbus, the ID of that
handler is given by textHandlerID
.
By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions
or HttpServerOptions
.
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.
textHandlerID
in interface WebSocketBase
public String subProtocol()
null
when the handler receives the WebSocket callback as the
handshake will not be completed yet.subProtocol
in interface WebSocketBase
public Short closeStatusCode()
null
when not yet received.closeStatusCode
in interface WebSocketBase
public String closeReason()
null
when not yet received.closeReason
in interface WebSocketBase
public MultiMap headers()
null
on subsequent interactions.headers
in interface WebSocketBase
public Completable writePing(Buffer data)
This 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 WebSocketBase
data
- the data to write, may be at most 125 bytespublic Completable rxWritePing(Buffer data)
This 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.
rxWritePing
in interface WebSocketBase
data
- the data to write, may be at most 125 bytespublic Completable writePong(Buffer data)
This 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 WebSocketBase
data
- the data to write, may be at most 125 bytespublic Completable rxWritePong(Buffer data)
This 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.
rxWritePong
in interface WebSocketBase
data
- the data to write, may be at most 125 bytespublic WebSocketBase textMessageHandler(Handler<String> handler)
WebSocketBase.binaryMessageHandler(io.vertx.core.Handler<io.vertx.rxjava3.core.buffer.Buffer>)
, but the buffer will be converted to a String firsttextMessageHandler
in interface WebSocketBase
handler
- the handlerpublic WebSocketBase binaryMessageHandler(Handler<Buffer> handler)
handler(io.vertx.core.Handler<io.vertx.rxjava3.core.buffer.Buffer>)
except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated
into a single buffer before calling the handler (using WebSocketFrame.isFinal()
to find the boundaries).binaryMessageHandler
in interface WebSocketBase
handler
- the handlerpublic WebSocketBase pongHandler(Handler<Buffer> handler)
Pong frames may be at most 125 bytes (octets).
There is no ping handler since ping frames should immediately be responded to with a pong frame with identical content
Pong frames may be received unsolicited.
pongHandler
in interface WebSocketBase
handler
- the handlerpublic Completable end()
WebSocketBase.close()
end
in interface WebSocketBase
end
in interface WriteStream<Buffer>
public Completable rxEnd()
WebSocketBase.close()
rxEnd
in interface WebSocketBase
rxEnd
in interface WriteStream<Buffer>
public Completable close()
WebSocketBase.close()
but with an handler
called when the operation completesclose
in interface WebSocketBase
public Completable rxClose()
WebSocketBase.close()
but with an handler
called when the operation completesrxClose
in interface WebSocketBase
public Completable close(short statusCode)
WebSocketBase.close()
but with an handler
called when the operation completesclose
in interface WebSocketBase
statusCode
- public Completable rxClose(short statusCode)
WebSocketBase.close()
but with an handler
called when the operation completesrxClose
in interface WebSocketBase
statusCode
- public Completable close(short statusCode, String reason)
WebSocketBase.close()
but with an handler
called when the operation completesclose
in interface WebSocketBase
statusCode
- reason
- public Completable rxClose(short statusCode, String reason)
WebSocketBase.close()
but with an handler
called when the operation completesrxClose
in interface WebSocketBase
statusCode
- reason
- public SocketAddress remoteAddress()
remoteAddress
in interface WebSocketBase
null
(e.g a server bound on a domain socket). If useProxyProtocol
is set to true
, the address returned will be of the actual connecting client.public SocketAddress localAddress()
localAddress
in interface WebSocketBase
null
(e.g a server bound on a domain socket) If useProxyProtocol
is set to true
, the address returned will be of the proxy.public boolean isSsl()
isSsl
in interface WebSocketBase
HttpConnection
is encrypted via SSL/TLS.public boolean isClosed()
isClosed
in interface WebSocketBase
true
if the WebSocket is closedpublic WebSocket exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface WebSocketBase
exceptionHandler
in interface ReadStream<Buffer>
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WriteStream<Buffer>
handler
- the exception handlerpublic WebSocket handler(Handler<Buffer> handler)
ReadStream
handler
in interface WebSocketBase
handler
in interface ReadStream<Buffer>
public 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 WebSocketBase
pause
in interface ReadStream<Buffer>
public WebSocket resume()
ReadStream
flowing
mode.
If the ReadStream
has been paused, reading will recommence on it.resume
in interface WebSocketBase
resume
in interface ReadStream<Buffer>
public 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 WebSocketBase
fetch
in interface ReadStream<Buffer>
public WebSocket endHandler(Handler<Void> endHandler)
ReadStream
endHandler
in interface WebSocketBase
endHandler
in interface ReadStream<Buffer>
public 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
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 WebSocketBase
setWriteQueueMaxSize
in interface WriteStream<Buffer>
maxSize
- the max size of the write streampublic WebSocket drainHandler(Handler<Void> handler)
WriteStream
Pipe
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 handlerpublic Completable writeFrame(WebSocketFrame frame)
WebSocketBase
WebSocketBase.writeFrame(io.vertx.rxjava3.core.http.WebSocketFrame)
but with an handler
called when the operation completeswriteFrame
in interface WebSocketBase
public Completable rxWriteFrame(WebSocketFrame frame)
WebSocketBase
WebSocketBase.writeFrame(io.vertx.rxjava3.core.http.WebSocketFrame)
but with an handler
called when the operation completesrxWriteFrame
in interface WebSocketBase
public Completable writeFinalTextFrame(String text)
WebSocketBase
WebSocketBase.writeFinalTextFrame(java.lang.String)
but with an handler
called when the operation completeswriteFinalTextFrame
in interface WebSocketBase
public Completable rxWriteFinalTextFrame(String text)
WebSocketBase
WebSocketBase.writeFinalTextFrame(java.lang.String)
but with an handler
called when the operation completesrxWriteFinalTextFrame
in interface WebSocketBase
public Completable writeFinalBinaryFrame(Buffer data)
WebSocketBase
WebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava3.core.buffer.Buffer)
but with an handler
called when the operation completeswriteFinalBinaryFrame
in interface WebSocketBase
public Completable rxWriteFinalBinaryFrame(Buffer data)
WebSocketBase
WebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava3.core.buffer.Buffer)
but with an handler
called when the operation completesrxWriteFinalBinaryFrame
in interface WebSocketBase
public Completable writeBinaryMessage(Buffer data)
WebSocketBase
WebSocketBase.writeBinaryMessage(io.vertx.rxjava3.core.buffer.Buffer)
but with an handler
called when the operation completeswriteBinaryMessage
in interface WebSocketBase
public Completable rxWriteBinaryMessage(Buffer data)
WebSocketBase
WebSocketBase.writeBinaryMessage(io.vertx.rxjava3.core.buffer.Buffer)
but with an handler
called when the operation completesrxWriteBinaryMessage
in interface WebSocketBase
public Completable writeTextMessage(String text)
WebSocketBase
WebSocketBase.writeTextMessage(java.lang.String)
but with an handler
called when the operation completeswriteTextMessage
in interface WebSocketBase
public Completable rxWriteTextMessage(String text)
WebSocketBase
WebSocketBase.writeTextMessage(java.lang.String)
but with an handler
called when the operation completesrxWriteTextMessage
in interface WebSocketBase
public 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 handlerpublic WebSocket frameHandler(Handler<WebSocketFrame> handler)
WebSocketBase
frameHandler
in interface WebSocketBase
handler
- the handlerpublic SSLSession sslSession()
Copyright © 2023 Eclipse. All rights reserved.