public class ClientWebSocket extends WebSocket
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<ClientWebSocket> |
__TYPE_ARG |
| Constructor and Description |
|---|
ClientWebSocket(ClientWebSocket delegate) |
ClientWebSocket(Object 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. |
ClientWebSocket |
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 |
ClientWebSocket |
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. |
Single<WebSocket> |
connect(int port,
String host,
String requestURI)
Connect a WebSocket to the specified port, host and relative request URI
|
Single<WebSocket> |
connect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.
|
Single<WebSocket> |
connect(String host,
String requestURI)
Connect this WebSocket to the host and relative request URI and default port.
|
Single<WebSocket> |
connect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.
|
ClientWebSocket |
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 |
ClientWebSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
boolean |
equals(Object o) |
ClientWebSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
ClientWebSocket |
frameHandler(Handler<WebSocketFrame> handler)
Set a frame handler on the connection.
|
ClientWebSocket |
getDelegate() |
ClientWebSocket |
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 ClientWebSocket |
newInstance(ClientWebSocket arg) |
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. |
ClientWebSocket |
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.
|
SocketAddress |
remoteAddress() |
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 |
Single<WebSocket> |
rxConnect(int port,
String host,
String requestURI)
Connect a WebSocket to the specified port, host and relative request URI
|
Single<WebSocket> |
rxConnect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.
|
Single<WebSocket> |
rxConnect(String host,
String requestURI)
Connect this WebSocket to the host and relative request URI and default port.
|
Single<WebSocket> |
rxConnect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.
|
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 |
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. |
ClientWebSocket |
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 WebSocket.setWriteQueueMaxSize(int) |
Completable |
writeTextMessage(String text)
Same as
WebSocketBase.writeTextMessage(java.lang.String) but with an handler called when the operation completes |
fetch, newInstance, pause, resume, setWriteQueueMaxSizeclone, finalize, getClass, notify, notifyAll, wait, wait, waitnewInstancenewInstance, newInstancenewInstance, newInstancenewInstancepublic static final io.vertx.lang.rx.TypeArg<ClientWebSocket> __TYPE_ARG
public ClientWebSocket(ClientWebSocket delegate)
public ClientWebSocket(Object delegate)
public ClientWebSocket getDelegate()
getDelegate in interface WebSocketBasegetDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasegetDelegate in interface WriteStream<Buffer>getDelegate in class WebSocketpublic Observable<Buffer> toObservable()
toObservable in interface ReadStream<Buffer>toObservable in class WebSocketpublic Flowable<Buffer> toFlowable()
toFlowable in interface ReadStream<Buffer>toFlowable in class WebSocketpublic WriteStreamObserver<Buffer> toObserver()
toObserver in class WebSocketpublic WriteStreamSubscriber<Buffer> toSubscriber()
toSubscriber in class WebSocketpublic Pipe<Buffer> pipe()
WriteStream.pipe in interface WebSocketBasepipe in interface ReadStream<Buffer>pipe in class WebSocketpublic 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 WebSocketBasepipeTo in interface ReadStream<Buffer>pipeTo in class WebSocketdst - 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 WebSocketBaserxPipeTo in interface ReadStream<Buffer>rxPipeTo in class WebSocketdst - the destination write streampublic Completable write(Buffer data)
handler called when the operation completeswrite in interface WebSocketBasewrite in interface WriteStream<Buffer>write in class WebSocketdata - public Completable rxWrite(Buffer data)
handler called when the operation completesrxWrite in interface WebSocketBaserxWrite in interface WriteStream<Buffer>rxWrite in class WebSocketdata - public Completable end(Buffer data)
handler called when the operation completesend in interface WebSocketBaseend in interface WriteStream<Buffer>end in class WebSocketdata - public Completable rxEnd(Buffer data)
handler called when the operation completesrxEnd in interface WebSocketBaserxEnd in interface WriteStream<Buffer>rxEnd in class WebSocketdata - public boolean writeQueueFull()
true if there are more bytes in the write queue than the value set using WebSocket.setWriteQueueMaxSize(int)writeQueueFull in interface WebSocketBasewriteQueueFull in interface WriteStream<Buffer>writeQueueFull in class WebSockettrue 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 WebSocketBasebinaryHandlerID in class WebSocketpublic 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 WebSocketBasetextHandlerID in class WebSocketpublic String subProtocol()
null when the handler receives the WebSocket callback as the
handshake will not be completed yet.subProtocol in interface WebSocketBasesubProtocol in class WebSocketpublic Short closeStatusCode()
null when not yet received.closeStatusCode in interface WebSocketBasecloseStatusCode in class WebSocketpublic String closeReason()
null when not yet received.closeReason in interface WebSocketBasecloseReason in class WebSocketpublic MultiMap headers()
null on subsequent interactions.headers in interface WebSocketBaseheaders in class WebSocketpublic Completable end()
WebSocketBase.close()end in interface WebSocketBaseend in interface WriteStream<Buffer>end in class WebSocketpublic Completable rxEnd()
WebSocketBase.close()rxEnd in interface WebSocketBaserxEnd in interface WriteStream<Buffer>rxEnd in class WebSocketpublic Completable close()
WebSocketBase.close() but with an handler called when the operation completesclose in interface WebSocketBaseclose in class WebSocketpublic Completable rxClose()
WebSocketBase.close() but with an handler called when the operation completesrxClose in interface WebSocketBaserxClose in class WebSocketpublic Completable close(short statusCode)
WebSocketBase.close() but with an handler called when the operation completesclose in interface WebSocketBaseclose in class WebSocketstatusCode - public Completable rxClose(short statusCode)
WebSocketBase.close() but with an handler called when the operation completesrxClose in interface WebSocketBaserxClose in class WebSocketstatusCode - public Completable close(short statusCode, String reason)
WebSocketBase.close() but with an handler called when the operation completesclose in interface WebSocketBaseclose in class WebSocketstatusCode - reason - public Completable rxClose(short statusCode, String reason)
WebSocketBase.close() but with an handler called when the operation completesrxClose in interface WebSocketBaserxClose in class WebSocketstatusCode - reason - public SocketAddress remoteAddress()
remoteAddress in interface WebSocketBaseremoteAddress in class WebSocketnull (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 WebSocketBaselocalAddress in class WebSocketnull (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 WebSocketBaseisSsl in class WebSocketHttpConnection is encrypted via SSL/TLS.public boolean isClosed()
isClosed in interface WebSocketBaseisClosed in class WebSockettrue if the WebSocket is closedpublic Single<WebSocket> connect(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIpublic Single<WebSocket> rxConnect(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIpublic Single<WebSocket> connect(WebSocketConnectOptions options)
options - the request optionspublic Single<WebSocket> rxConnect(WebSocketConnectOptions options)
options - the request optionspublic Single<WebSocket> connect(String host, String requestURI)
host - the hostrequestURI - the relative URIpublic Single<WebSocket> rxConnect(String host, String requestURI)
host - the hostrequestURI - the relative URIpublic Single<WebSocket> connect(String requestURI)
requestURI - the relative URIpublic Single<WebSocket> rxConnect(String requestURI)
requestURI - the relative URIpublic ClientWebSocket handler(Handler<Buffer> handler)
ReadStreamhandler in interface WebSocketBasehandler in interface ReadStream<Buffer>handler in class WebSocketpublic ClientWebSocket endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface WebSocketBaseendHandler in interface ReadStream<Buffer>endHandler in class WebSocketpublic ClientWebSocket 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>drainHandler in class WebSockethandler - the handlerpublic ClientWebSocket closeHandler(Handler<Void> handler)
WebSocketBaseWebSocketBase.closeStatusCode() will return the status code and WebSocketBase.closeReason() will return the reason.closeHandler in interface WebSocketBasecloseHandler in class WebSockethandler - the handlerpublic ClientWebSocket frameHandler(Handler<WebSocketFrame> handler)
WebSocketBaseframeHandler in interface WebSocketBaseframeHandler in class WebSockethandler - the handlerpublic ClientWebSocket textMessageHandler(Handler<String> handler)
WebSocketWebSocketBase.binaryMessageHandler(io.vertx.core.Handler<io.vertx.rxjava3.core.buffer.Buffer>), but the buffer will be converted to a String firsttextMessageHandler in interface WebSocketBasetextMessageHandler in class WebSockethandler - the handlerpublic ClientWebSocket binaryMessageHandler(Handler<Buffer> handler)
WebSocketWebSocket.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 WebSocketBasebinaryMessageHandler in class WebSockethandler - the handlerpublic ClientWebSocket pongHandler(Handler<Buffer> handler)
WebSocketPong 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 WebSocketBasepongHandler in class WebSockethandler - the handlerpublic ClientWebSocket exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface WebSocketBaseexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>exceptionHandler in class WebSockethandler - the exception handlerpublic Completable writeFrame(WebSocketFrame frame)
WebSocketBaseWebSocketBase.writeFrame(io.vertx.rxjava3.core.http.WebSocketFrame) but with an handler called when the operation completeswriteFrame in interface WebSocketBasewriteFrame in class WebSocketpublic Completable rxWriteFrame(WebSocketFrame frame)
WebSocketBaseWebSocketBase.writeFrame(io.vertx.rxjava3.core.http.WebSocketFrame) but with an handler called when the operation completesrxWriteFrame in interface WebSocketBaserxWriteFrame in class WebSocketpublic Completable writeFinalTextFrame(String text)
WebSocketBaseWebSocketBase.writeFinalTextFrame(java.lang.String) but with an handler called when the operation completeswriteFinalTextFrame in interface WebSocketBasewriteFinalTextFrame in class WebSocketpublic Completable rxWriteFinalTextFrame(String text)
WebSocketBaseWebSocketBase.writeFinalTextFrame(java.lang.String) but with an handler called when the operation completesrxWriteFinalTextFrame in interface WebSocketBaserxWriteFinalTextFrame in class WebSocketpublic Completable writeFinalBinaryFrame(Buffer data)
WebSocketBaseWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completeswriteFinalBinaryFrame in interface WebSocketBasewriteFinalBinaryFrame in class WebSocketpublic Completable rxWriteFinalBinaryFrame(Buffer data)
WebSocketBaseWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completesrxWriteFinalBinaryFrame in interface WebSocketBaserxWriteFinalBinaryFrame in class WebSocketpublic Completable writeBinaryMessage(Buffer data)
WebSocketBaseWebSocketBase.writeBinaryMessage(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completeswriteBinaryMessage in interface WebSocketBasewriteBinaryMessage in class WebSocketpublic Completable rxWriteBinaryMessage(Buffer data)
WebSocketBaseWebSocketBase.writeBinaryMessage(io.vertx.rxjava3.core.buffer.Buffer) but with an handler called when the operation completesrxWriteBinaryMessage in interface WebSocketBaserxWriteBinaryMessage in class WebSocketpublic Completable writeTextMessage(String text)
WebSocketBaseWebSocketBase.writeTextMessage(java.lang.String) but with an handler called when the operation completeswriteTextMessage in interface WebSocketBasewriteTextMessage in class WebSocketpublic Completable rxWriteTextMessage(String text)
WebSocketBaseWebSocketBase.writeTextMessage(java.lang.String) but with an handler called when the operation completesrxWriteTextMessage in interface WebSocketBaserxWriteTextMessage in class WebSocketpublic Completable writePing(Buffer data)
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 WebSocketBasewritePing in class WebSocketdata - the data to write, may be at most 125 bytespublic Completable rxWritePing(Buffer data)
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.
rxWritePing in interface WebSocketBaserxWritePing in class WebSocketdata - the data to write, may be at most 125 bytespublic Completable writePong(Buffer data)
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 WebSocketBasewritePong in class WebSocketdata - the data to write, may be at most 125 bytespublic Completable rxWritePong(Buffer data)
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.
rxWritePong in interface WebSocketBaserxWritePong in class WebSocketdata - the data to write, may be at most 125 bytespublic SSLSession sslSession()
sslSession in class WebSocketpublic static ClientWebSocket newInstance(ClientWebSocket arg)
Copyright © 2023 Eclipse. All rights reserved.