Class ClientWebSocket
- java.lang.Object
-
- io.vertx.rxjava3.core.http.WebSocket
-
- io.vertx.rxjava3.core.http.ClientWebSocket
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,WebSocketBase,ReadStream<Buffer>,StreamBase,WriteStream<Buffer>
public class ClientWebSocket extends WebSocket implements io.vertx.lang.rx.RxDelegate
Represents a client-side WebSocket.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<ClientWebSocket>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description ClientWebSocket(ClientWebSocket delegate)ClientWebSocket(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbinaryHandlerID()When aWebSocketis created, it may register an event handler with the event bus - the ID of that handler is given by this method.ClientWebSocketbinaryMessageHandler(Handler<Buffer> handler)Set a binary message handler on the connection.Completableclose()Close the WebSocket sending the default close frame.Completableclose(short statusCode)Close the WebSocket sending a close frame with specified status code.Completableclose(short statusCode, String reason)Close sending a close frame with specified status code and reason.ClientWebSocketcloseHandler(Handler<Void> handler)Set a close handler.StringcloseReason()Returns the close reason message from the remote endpoint ornullwhen not yet received.ShortcloseStatusCode()Returns the close status code received from the remote endpoint ornullwhen not yet received.Single<WebSocket>connect(int port, String host, String requestURI)Connect this WebSocket to the specified port, host and relative request URI.Single<WebSocket>connect(WebSocketConnectOptions options)Connect this WebSocket with the specified options.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.ClientWebSocketdrainHandler(Handler<Void> handler)Set a drain handler on the stream.Completableend()CallsWebSocketBase.close()Completableend(Buffer data)Same asWebSocketBase.end(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.ClientWebSocketendHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)ClientWebSocketexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.ClientWebSocketfetch(long amount)Fetch the specifiedamountof elements.ClientWebSocketframeHandler(Handler<WebSocketFrame> handler)Set a frame handler on the connection.ClientWebSocketgetDelegate()ClientWebSockethandler(Handler<Buffer> handler)Set a data handler.inthashCode()MultiMapheaders()Returns the HTTP headers.booleanisClosed()booleanisSsl()SocketAddresslocalAddress()static ClientWebSocketnewInstance(ClientWebSocket arg)ClientWebSocketpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<Buffer>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .CompletablepipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.ClientWebSocketpongHandler(Handler<Buffer> handler)Set a pong frame handler on the connection.SocketAddressremoteAddress()ClientWebSocketresume()Resume reading, and sets the buffer inflowingmode.CompletablerxClose()Close the WebSocket sending the default close frame.CompletablerxClose(short statusCode)Close the WebSocket sending a close frame with specified status code.CompletablerxClose(short statusCode, String reason)Close sending a close frame with specified status code and reason.Single<WebSocket>rxConnect(int port, String host, String requestURI)Connect this WebSocket to the specified port, host and relative request URI.Single<WebSocket>rxConnect(WebSocketConnectOptions options)Connect this WebSocket with the specified options.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.CompletablerxEnd()CallsWebSocketBase.close()CompletablerxEnd(Buffer data)Same asWebSocketBase.end(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.CompletablerxPipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.CompletablerxShutdown()CompletablerxShutdown(long timeout, TimeUnit unit)CompletablerxShutdown(long timeout, TimeUnit unit, short statusCode)CallsWebSocketBase.shutdown()with anullreason.CompletablerxShutdown(long timeout, TimeUnit unit, short statusCode, String reason)Initiate a graceful WebSocket shutdown, the shutdown handler is notified and shall close the WebSocket, otherwise after atimeoutthe WebSocket will be closed.CompletablerxShutdown(short statusCode)LikeWebSocketBase.shutdown()with a 30 seconds timeout and anullreason.CompletablerxShutdown(short statusCode, String reason)LikeWebSocketBase.shutdown()with a 30 seconds timeout.CompletablerxWrite(Buffer data)Write some data to the stream.CompletablerxWriteBinaryMessage(Buffer data)Writes a (potentially large) piece of binary data to the connection.CompletablerxWriteFinalBinaryFrame(Buffer data)Write a final WebSocket binary frame to the connectionCompletablerxWriteFinalTextFrame(String text)Write a final WebSocket text frame to the connectionCompletablerxWriteFrame(WebSocketFrame frame)Write a WebSocket frame to the connectionCompletablerxWritePing(Buffer data)Writes a ping frame to the connection.CompletablerxWritePong(Buffer data)Writes a pong frame to the connection.CompletablerxWriteTextMessage(String text)Writes a (potentially large) piece of text data to the connection.ClientWebSocketsetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.Completableshutdown()Completableshutdown(long timeout, TimeUnit unit)Completableshutdown(long timeout, TimeUnit unit, short statusCode)CallsWebSocketBase.shutdown()with anullreason.Completableshutdown(long timeout, TimeUnit unit, short statusCode, String reason)Initiate a graceful WebSocket shutdown, the shutdown handler is notified and shall close the WebSocket, otherwise after atimeoutthe WebSocket will be closed.Completableshutdown(short statusCode)LikeWebSocketBase.shutdown()with a 30 seconds timeout and anullreason.Completableshutdown(short statusCode, String reason)LikeWebSocketBase.shutdown()with a 30 seconds timeout.SSLSessionsslSession()StringsubProtocol()Returns the WebSocket sub protocol selected by the WebSocket handshake.StringtextHandlerID()When aWebSocketis created, it may register an event handler with the eventbus, the ID of that handler is given bytextHandlerID.ClientWebSockettextMessageHandler(Handler<String> handler)Set a text message handler on the connection.Flowable<Buffer>toFlowable()Observable<Buffer>toObservable()WriteStreamObserver<Buffer>toObserver()StringtoString()WriteStreamSubscriber<Buffer>toSubscriber()Completablewrite(Buffer data)Write some data to the stream.CompletablewriteBinaryMessage(Buffer data)Writes a (potentially large) piece of binary data to the connection.CompletablewriteFinalBinaryFrame(Buffer data)Write a final WebSocket binary frame to the connectionCompletablewriteFinalTextFrame(String text)Write a final WebSocket text frame to the connectionCompletablewriteFrame(WebSocketFrame frame)Write a WebSocket frame to the connectionCompletablewritePing(Buffer data)Writes a ping frame to the connection.CompletablewritePong(Buffer data)Writes a pong frame to the connection.booleanwriteQueueFull()This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)CompletablewriteTextMessage(String text)Writes a (potentially large) piece of text data to the connection.-
Methods inherited from class io.vertx.rxjava3.core.http.WebSocket
newInstance, shutdownHandler
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<ClientWebSocket> __TYPE_ARG
-
-
Constructor Detail
-
ClientWebSocket
public ClientWebSocket(ClientWebSocket delegate)
-
ClientWebSocket
public ClientWebSocket(Object delegate)
-
-
Method Detail
-
getDelegate
public ClientWebSocket getDelegate()
- Specified by:
getDelegatein interfaceReadStream<Buffer>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase- Specified by:
getDelegatein interfaceWebSocketBase- Specified by:
getDelegatein interfaceWriteStream<Buffer>- Overrides:
getDelegatein classWebSocket
-
toObservable
public Observable<Buffer> toObservable()
- Specified by:
toObservablein interfaceReadStream<Buffer>- Overrides:
toObservablein classWebSocket
-
toFlowable
public Flowable<Buffer> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<Buffer>- Overrides:
toFlowablein classWebSocket
-
toObserver
public WriteStreamObserver<Buffer> toObserver()
- Specified by:
toObserverin interfaceWriteStream<Buffer>- Overrides:
toObserverin classWebSocket
-
toSubscriber
public WriteStreamSubscriber<Buffer> toSubscriber()
- Specified by:
toSubscriberin interfaceWriteStream<Buffer>- Overrides:
toSubscriberin classWebSocket
-
pipe
public Pipe<Buffer> pipe()
Pause this stream and return a to transfer the elements of this stream to a destination . The stream will be resumed when the pipe will be wired to aWriteStream.- Specified by:
pipein interfaceReadStream<Buffer>- Specified by:
pipein interfaceWebSocketBase- Overrides:
pipein classWebSocket- Returns:
- a pipe
-
pipeTo
public Completable pipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<Buffer>- Specified by:
pipeToin interfaceWebSocketBase- Overrides:
pipeToin classWebSocket- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
rxPipeTo
public Completable rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin interfaceReadStream<Buffer>- Specified by:
rxPipeToin interfaceWebSocketBase- Overrides:
rxPipeToin classWebSocket- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
write
public Completable write(Buffer data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
writein interfaceWebSocketBase- Specified by:
writein interfaceWriteStream<Buffer>- Overrides:
writein classWebSocket- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
rxWrite
public Completable rxWrite(Buffer data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
rxWritein interfaceWebSocketBase- Specified by:
rxWritein interfaceWriteStream<Buffer>- Overrides:
rxWritein classWebSocket- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
end
public Completable end(Buffer data)
Same asWebSocketBase.end(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.- Specified by:
endin interfaceWebSocketBase- Specified by:
endin interfaceWriteStream<Buffer>- Overrides:
endin classWebSocket- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd(Buffer data)
Same asWebSocketBase.end(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.- Specified by:
rxEndin interfaceWebSocketBase- Specified by:
rxEndin interfaceWriteStream<Buffer>- Overrides:
rxEndin classWebSocket- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
writeQueueFull
public boolean writeQueueFull()
This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)- Specified by:
writeQueueFullin interfaceWebSocketBase- Specified by:
writeQueueFullin interfaceWriteStream<Buffer>- Overrides:
writeQueueFullin classWebSocket- Returns:
trueif write queue is full
-
binaryHandlerID
public String binaryHandlerID()
When aWebSocketis 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
WebSocketConnectOptionsorHttpServerOptions.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.
- Specified by:
binaryHandlerIDin interfaceWebSocketBase- Overrides:
binaryHandlerIDin classWebSocket- Returns:
- the binary handler id
-
textHandlerID
public String textHandlerID()
When aWebSocketis created, it may register an event handler with the eventbus, the ID of that handler is given bytextHandlerID.By default, no handler is registered, the feature must be enabled via
WebSocketConnectOptionsorHttpServerOptions.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.
- Specified by:
textHandlerIDin interfaceWebSocketBase- Overrides:
textHandlerIDin classWebSocket- Returns:
- the text handler id
-
subProtocol
public String subProtocol()
Returns the WebSocket sub protocol selected by the WebSocket handshake. On the server, the value will benullwhen the handler receives the WebSocket callback as the handshake will not be completed yet.- Specified by:
subProtocolin interfaceWebSocketBase- Overrides:
subProtocolin classWebSocket- Returns:
-
closeStatusCode
public Short closeStatusCode()
Returns the close status code received from the remote endpoint ornullwhen not yet received.- Specified by:
closeStatusCodein interfaceWebSocketBase- Overrides:
closeStatusCodein classWebSocket- Returns:
-
closeReason
public String closeReason()
Returns the close reason message from the remote endpoint ornullwhen not yet received.- Specified by:
closeReasonin interfaceWebSocketBase- Overrides:
closeReasonin classWebSocket- Returns:
-
headers
public MultiMap headers()
Returns the HTTP headers.- Specified by:
headersin interfaceWebSocketBase- Overrides:
headersin classWebSocket- Returns:
- the headers
-
writeFrame
public Completable writeFrame(WebSocketFrame frame)
Write a WebSocket frame to the connection- Specified by:
writeFramein interfaceWebSocketBase- Overrides:
writeFramein classWebSocket- Parameters:
frame- the frame to write- Returns:
- a future completed with the result
-
rxWriteFrame
public Completable rxWriteFrame(WebSocketFrame frame)
Write a WebSocket frame to the connection- Specified by:
rxWriteFramein interfaceWebSocketBase- Overrides:
rxWriteFramein classWebSocket- Parameters:
frame- the frame to write- Returns:
- a future completed with the result
-
writeFinalTextFrame
public Completable writeFinalTextFrame(String text)
Write a final WebSocket text frame to the connection- Specified by:
writeFinalTextFramein interfaceWebSocketBase- Overrides:
writeFinalTextFramein classWebSocket- Parameters:
text- The text to write- Returns:
- a future completed with the result
-
rxWriteFinalTextFrame
public Completable rxWriteFinalTextFrame(String text)
Write a final WebSocket text frame to the connection- Specified by:
rxWriteFinalTextFramein interfaceWebSocketBase- Overrides:
rxWriteFinalTextFramein classWebSocket- Parameters:
text- The text to write- Returns:
- a future completed with the result
-
writeFinalBinaryFrame
public Completable writeFinalBinaryFrame(Buffer data)
Write a final WebSocket binary frame to the connection- Specified by:
writeFinalBinaryFramein interfaceWebSocketBase- Overrides:
writeFinalBinaryFramein classWebSocket- Parameters:
data- The data to write- Returns:
- a future completed with the result
-
rxWriteFinalBinaryFrame
public Completable rxWriteFinalBinaryFrame(Buffer data)
Write a final WebSocket binary frame to the connection- Specified by:
rxWriteFinalBinaryFramein interfaceWebSocketBase- Overrides:
rxWriteFinalBinaryFramein classWebSocket- Parameters:
data- The data to write- Returns:
- a future completed with the result
-
writeBinaryMessage
public Completable writeBinaryMessage(Buffer data)
Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.- Specified by:
writeBinaryMessagein interfaceWebSocketBase- Overrides:
writeBinaryMessagein classWebSocket- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
rxWriteBinaryMessage
public Completable rxWriteBinaryMessage(Buffer data)
Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.- Specified by:
rxWriteBinaryMessagein interfaceWebSocketBase- Overrides:
rxWriteBinaryMessagein classWebSocket- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
writeTextMessage
public Completable writeTextMessage(String text)
Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.- Specified by:
writeTextMessagein interfaceWebSocketBase- Overrides:
writeTextMessagein classWebSocket- Parameters:
text- the data to write- Returns:
- a future completed with the result
-
rxWriteTextMessage
public Completable rxWriteTextMessage(String text)
Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.- Specified by:
rxWriteTextMessagein interfaceWebSocketBase- Overrides:
rxWriteTextMessagein classWebSocket- Parameters:
text- the data to write- Returns:
- a future completed with the result
-
writePing
public Completable writePing(Buffer data)
Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).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.
- Specified by:
writePingin interfaceWebSocketBase- Overrides:
writePingin classWebSocket- Parameters:
data- the data to write, may be at most 125 bytes- Returns:
- a future notified when the ping frame has been successfully written
-
rxWritePing
public Completable rxWritePing(Buffer data)
Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).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.
- Specified by:
rxWritePingin interfaceWebSocketBase- Overrides:
rxWritePingin classWebSocket- Parameters:
data- the data to write, may be at most 125 bytes- Returns:
- a future notified when the ping frame has been successfully written
-
writePong
public Completable writePong(Buffer data)
Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).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.
- Specified by:
writePongin interfaceWebSocketBase- Overrides:
writePongin classWebSocket- Parameters:
data- the data to write, may be at most 125 bytes- Returns:
- a future notified when the pong frame has been successfully written
-
rxWritePong
public Completable rxWritePong(Buffer data)
Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).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.
- Specified by:
rxWritePongin interfaceWebSocketBase- Overrides:
rxWritePongin classWebSocket- Parameters:
data- the data to write, may be at most 125 bytes- Returns:
- a future notified when the pong frame has been successfully written
-
end
public Completable end()
CallsWebSocketBase.close()- Specified by:
endin interfaceWebSocketBase- Specified by:
endin interfaceWriteStream<Buffer>- Overrides:
endin classWebSocket- Returns:
-
rxEnd
public Completable rxEnd()
CallsWebSocketBase.close()- Specified by:
rxEndin interfaceWebSocketBase- Specified by:
rxEndin interfaceWriteStream<Buffer>- Overrides:
rxEndin classWebSocket- Returns:
-
close
public Completable close()
Close the WebSocket sending the default close frame. No more messages can be sent.- Specified by:
closein interfaceWebSocketBase- Overrides:
closein classWebSocket- Returns:
- a future completed with the result
-
rxClose
public Completable rxClose()
Close the WebSocket sending the default close frame. No more messages can be sent.- Specified by:
rxClosein interfaceWebSocketBase- Overrides:
rxClosein classWebSocket- Returns:
- a future completed with the result
-
close
public Completable close(short statusCode)
Close the WebSocket sending a close frame with specified status code. You can give a look at various close payloads here: RFC6455 section 7.4.1 No more messages can be sent.- Specified by:
closein interfaceWebSocketBase- Overrides:
closein classWebSocket- Parameters:
statusCode- the status code- Returns:
- a future completed with the result
-
rxClose
public Completable rxClose(short statusCode)
Close the WebSocket sending a close frame with specified status code. You can give a look at various close payloads here: RFC6455 section 7.4.1 No more messages can be sent.- Specified by:
rxClosein interfaceWebSocketBase- Overrides:
rxClosein classWebSocket- Parameters:
statusCode- the status code- Returns:
- a future completed with the result
-
close
public Completable close(short statusCode, String reason)
Close sending a close frame with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1 No more messages can be sent.- Specified by:
closein interfaceWebSocketBase- Overrides:
closein classWebSocket- Parameters:
statusCode- the status codereason- reason of closure- Returns:
- a future completed with the result
-
rxClose
public Completable rxClose(short statusCode, String reason)
Close sending a close frame with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1 No more messages can be sent.- Specified by:
rxClosein interfaceWebSocketBase- Overrides:
rxClosein classWebSocket- Parameters:
statusCode- the status codereason- reason of closure- Returns:
- a future completed with the result
-
shutdown
public Completable shutdown()
- Specified by:
shutdownin interfaceWebSocketBase- Overrides:
shutdownin classWebSocket- Returns:
-
rxShutdown
public Completable rxShutdown()
- Specified by:
rxShutdownin interfaceWebSocketBase- Overrides:
rxShutdownin classWebSocket- Returns:
-
shutdown
public Completable shutdown(short statusCode)
LikeWebSocketBase.shutdown()with a 30 seconds timeout and anullreason.- Specified by:
shutdownin interfaceWebSocketBase- Overrides:
shutdownin classWebSocket- Parameters:
statusCode-- Returns:
-
rxShutdown
public Completable rxShutdown(short statusCode)
LikeWebSocketBase.shutdown()with a 30 seconds timeout and anullreason.- Specified by:
rxShutdownin interfaceWebSocketBase- Overrides:
rxShutdownin classWebSocket- Parameters:
statusCode-- Returns:
-
shutdown
public Completable shutdown(short statusCode, String reason)
LikeWebSocketBase.shutdown()with a 30 seconds timeout.- Specified by:
shutdownin interfaceWebSocketBase- Overrides:
shutdownin classWebSocket- Parameters:
statusCode-reason-- Returns:
-
rxShutdown
public Completable rxShutdown(short statusCode, String reason)
LikeWebSocketBase.shutdown()with a 30 seconds timeout.- Specified by:
rxShutdownin interfaceWebSocketBase- Overrides:
rxShutdownin classWebSocket- Parameters:
statusCode-reason-- Returns:
-
shutdown
public Completable shutdown(long timeout, TimeUnit unit)
- Specified by:
shutdownin interfaceWebSocketBase- Overrides:
shutdownin classWebSocket- Parameters:
timeout-unit-- Returns:
-
rxShutdown
public Completable rxShutdown(long timeout, TimeUnit unit)
- Specified by:
rxShutdownin interfaceWebSocketBase- Overrides:
rxShutdownin classWebSocket- Parameters:
timeout-unit-- Returns:
-
shutdown
public Completable shutdown(long timeout, TimeUnit unit, short statusCode)
CallsWebSocketBase.shutdown()with anullreason.- Specified by:
shutdownin interfaceWebSocketBase- Overrides:
shutdownin classWebSocket- Parameters:
timeout-unit-statusCode-- Returns:
-
rxShutdown
public Completable rxShutdown(long timeout, TimeUnit unit, short statusCode)
CallsWebSocketBase.shutdown()with anullreason.- Specified by:
rxShutdownin interfaceWebSocketBase- Overrides:
rxShutdownin classWebSocket- Parameters:
timeout-unit-statusCode-- Returns:
-
shutdown
public Completable shutdown(long timeout, TimeUnit unit, short statusCode, String reason)
Initiate a graceful WebSocket shutdown, the shutdown handler is notified and shall close the WebSocket, otherwise after atimeoutthe WebSocket will be closed. The WebSocket is closed with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1- Specified by:
shutdownin interfaceWebSocketBase- Overrides:
shutdownin classWebSocket- Parameters:
timeout- the amount of time after which all resources are forcibly closedunit- the of the timeoutstatusCode- the status codereason- reason of closure- Returns:
- a future completed when shutdown has completed
-
rxShutdown
public Completable rxShutdown(long timeout, TimeUnit unit, short statusCode, String reason)
Initiate a graceful WebSocket shutdown, the shutdown handler is notified and shall close the WebSocket, otherwise after atimeoutthe WebSocket will be closed. The WebSocket is closed with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1- Specified by:
rxShutdownin interfaceWebSocketBase- Overrides:
rxShutdownin classWebSocket- Parameters:
timeout- the amount of time after which all resources are forcibly closedunit- the of the timeoutstatusCode- the status codereason- reason of closure- Returns:
- a future completed when shutdown has completed
-
remoteAddress
public SocketAddress remoteAddress()
- Specified by:
remoteAddressin interfaceWebSocketBase- Overrides:
remoteAddressin classWebSocket- Returns:
- the remote address for this connection, possibly
null(e.g a server bound on a domain socket). IfuseProxyProtocolis set totrue, the address returned will be of the actual connecting client.
-
localAddress
public SocketAddress localAddress()
- Specified by:
localAddressin interfaceWebSocketBase- Overrides:
localAddressin classWebSocket- Returns:
- the local address for this connection, possibly
null(e.g a server bound on a domain socket) IfuseProxyProtocolis set totrue, the address returned will be of the proxy.
-
isSsl
public boolean isSsl()
- Specified by:
isSslin interfaceWebSocketBase- Overrides:
isSslin classWebSocket- Returns:
- true if this
HttpConnectionis encrypted via SSL/TLS.
-
isClosed
public boolean isClosed()
- Specified by:
isClosedin interfaceWebSocketBase- Overrides:
isClosedin classWebSocket- Returns:
trueif the WebSocket cannot be used to send message anymore
-
connect
public Single<WebSocket> connect(WebSocketConnectOptions options)
Connect this WebSocket with the specified options.- Parameters:
options- the request options- Returns:
- a future notified when the WebSocket when connected
-
rxConnect
public Single<WebSocket> rxConnect(WebSocketConnectOptions options)
Connect this WebSocket with the specified options.- Parameters:
options- the request options- Returns:
- a future notified when the WebSocket when connected
-
connect
public Single<WebSocket> connect(int port, String host, String requestURI)
Connect this WebSocket to the specified port, host and relative request URI.- Parameters:
port- the porthost- the hostrequestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
rxConnect
public Single<WebSocket> rxConnect(int port, String host, String requestURI)
Connect this WebSocket to the specified port, host and relative request URI.- Parameters:
port- the porthost- the hostrequestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
connect
public Single<WebSocket> connect(String host, String requestURI)
Connect this WebSocket to the host and relative request URI and default port.- Parameters:
host- the hostrequestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
rxConnect
public Single<WebSocket> rxConnect(String host, String requestURI)
Connect this WebSocket to the host and relative request URI and default port.- Parameters:
host- the hostrequestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
connect
public Single<WebSocket> connect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.- Parameters:
requestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
rxConnect
public Single<WebSocket> rxConnect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.- Parameters:
requestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
pause
public ClientWebSocket pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<Buffer>- Specified by:
pausein interfaceWebSocketBase- Overrides:
pausein classWebSocket- Returns:
- a reference to this, so the API can be used fluently
-
resume
public ClientWebSocket resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<Buffer>- Specified by:
resumein interfaceWebSocketBase- Overrides:
resumein classWebSocket- Returns:
- a reference to this, so the API can be used fluently
-
fetch
public ClientWebSocket fetch(long amount)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<Buffer>- Specified by:
fetchin interfaceWebSocketBase- Overrides:
fetchin classWebSocket- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
public ClientWebSocket setWriteQueueMaxSize(int maxSize)
Description copied from interface:WriteStreamSet the maximum size of the write queue tomaxSize. You will still be able to write to the stream even if there is more thanmaxSizeitems in the write queue. This is used as an indicator by classes such asPipeto provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket, etc...- Specified by:
setWriteQueueMaxSizein interfaceWebSocketBase- Specified by:
setWriteQueueMaxSizein interfaceWriteStream<Buffer>- Overrides:
setWriteQueueMaxSizein classWebSocket- Parameters:
maxSize- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
handler
public ClientWebSocket handler(Handler<Buffer> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<Buffer>- Specified by:
handlerin interfaceWebSocketBase- Overrides:
handlerin classWebSocket- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public ClientWebSocket endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<Buffer>- Specified by:
endHandlerin interfaceWebSocketBase- Overrides:
endHandlerin classWebSocket- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
public ClientWebSocket drainHandler(Handler<Void> handler)
Description copied from interface:WriteStreamSet a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. SeePipefor 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.- Specified by:
drainHandlerin interfaceWebSocketBase- Specified by:
drainHandlerin interfaceWriteStream<Buffer>- Overrides:
drainHandlerin classWebSocket- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
closeHandler
public ClientWebSocket closeHandler(Handler<Void> handler)
Description copied from interface:WebSocketBaseSet a close handler. This will be called when the WebSocket is closed. After this callback, no more messages are expected. When the WebSocket received a close frame, theWebSocketBase.closeStatusCode()will return the status code andWebSocketBase.closeReason()will return the reason.- Specified by:
closeHandlerin interfaceWebSocketBase- Overrides:
closeHandlerin classWebSocket- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
frameHandler
public ClientWebSocket frameHandler(Handler<WebSocketFrame> handler)
Description copied from interface:WebSocketBaseSet a frame handler on the connection. This handler will be called when frames are read on the connection.- Specified by:
frameHandlerin interfaceWebSocketBase- Overrides:
frameHandlerin classWebSocket- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
textMessageHandler
public ClientWebSocket textMessageHandler(Handler<String> handler)
Description copied from interface:WebSocketBaseSet a text message handler on the connection. This handler will be called similar to theWebSocketBase.binaryMessageHandler(io.vertx.core.Handler<io.vertx.core.buffer.Buffer>), but the buffer will be converted to a String first- Specified by:
textMessageHandlerin interfaceWebSocketBase- Overrides:
textMessageHandlerin classWebSocket- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
binaryMessageHandler
public ClientWebSocket binaryMessageHandler(Handler<Buffer> handler)
Description copied from interface:WebSocketBaseSet a binary message handler on the connection. This handler serves a similar purpose toWebSocketBase.handler(io.vertx.core.Handler<io.vertx.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 (usingWebSocketFrameto find the boundaries).- Specified by:
binaryMessageHandlerin interfaceWebSocketBase- Overrides:
binaryMessageHandlerin classWebSocket- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
pongHandler
public ClientWebSocket pongHandler(Handler<Buffer> handler)
Description copied from interface:WebSocketBaseSet a pong frame handler on the connection. This handler will be invoked every time a pong frame is received on the server, and can be used by both clients and servers since the RFC 6455 section 5.5.2 and section 5.5.3 do not specify whether the client or server sends a ping.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.
- Specified by:
pongHandlerin interfaceWebSocketBase- Overrides:
pongHandlerin classWebSocket- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public ClientWebSocket exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<Buffer>- Specified by:
exceptionHandlerin interfaceStreamBase- Specified by:
exceptionHandlerin interfaceWebSocketBase- Specified by:
exceptionHandlerin interfaceWriteStream<Buffer>- Overrides:
exceptionHandlerin classWebSocket- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
sslSession
public SSLSession sslSession()
- Overrides:
sslSessionin classWebSocket- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
-
newInstance
public static ClientWebSocket newInstance(ClientWebSocket arg)
-
-