Class WebSocketClient
- java.lang.Object
-
- io.vertx.reactivex.core.http.WebSocketClient
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,Measured
public class WebSocketClient extends Object implements io.vertx.lang.rx.RxDelegate, Measured
An asynchronous WebSocket client.It allows you to open WebSockets to servers.
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<WebSocketClient>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description WebSocketClient(WebSocketClient delegate)WebSocketClient(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Future<Void>close()Close immediately (shutdown(0, TimeUnit.SECONDS).Future<WebSocket>connect(int port, String host, String requestURI)Connect a WebSocket to the specified port, host and relative request URI.Future<WebSocket>connect(WebSocketConnectOptions options)Connect a WebSocket with the specified options.Future<WebSocket>connect(String requestURI)Connect a WebSocket to the default client port, default client host and specified, relative request URI.Future<WebSocket>connect(String host, String requestURI)Connect a WebSocket to the default client port and specified host and relative request URI.booleanequals(Object o)WebSocketClientgetDelegate()inthashCode()booleanisMetricsEnabled()Whether the metrics are enabled for this measured objectstatic WebSocketClientnewInstance(WebSocketClient arg)CompletablerxClose()Close immediately (shutdown(0, TimeUnit.SECONDS).Single<WebSocket>rxConnect(int port, String host, String requestURI)Connect a WebSocket to the specified port, host and relative request URI.Single<WebSocket>rxConnect(WebSocketConnectOptions options)Connect a WebSocket with the specified options.Single<WebSocket>rxConnect(String requestURI)Connect a WebSocket to the default client port, default client host and specified, relative request URI.Single<WebSocket>rxConnect(String host, String requestURI)Connect a WebSocket to the default client port and specified host and relative request URI.CompletablerxShutdown()Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).CompletablerxShutdown(long timeout, TimeUnit unit)Initiate the client shutdown sequence.Single<Boolean>rxUpdateSSLOptions(ClientSSLOptions options)Update the client with new SSLoptions, the update happens if the options object is valid and different from the existing options object.Single<Boolean>rxUpdateSSLOptions(ClientSSLOptions options, boolean force)Update the client with new SSLoptions, the update happens if the options object is valid and different from the existing options object.Future<Void>shutdown()Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).Future<Void>shutdown(long timeout, TimeUnit unit)Initiate the client shutdown sequence.StringtoString()Future<Boolean>updateSSLOptions(ClientSSLOptions options)Update the client with new SSLoptions, the update happens if the options object is valid and different from the existing options object.Future<Boolean>updateSSLOptions(ClientSSLOptions options, boolean force)Update the client with new SSLoptions, the update happens if the options object is valid and different from the existing options object.ClientWebSocketwebSocket()Create a WebSocket that is not yet connected to the server.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<WebSocketClient> __TYPE_ARG
-
-
Constructor Detail
-
WebSocketClient
public WebSocketClient(WebSocketClient delegate)
-
WebSocketClient
public WebSocketClient(Object delegate)
-
-
Method Detail
-
getDelegate
public WebSocketClient getDelegate()
- Specified by:
getDelegatein interfaceMeasured- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
isMetricsEnabled
public boolean isMetricsEnabled()
Whether the metrics are enabled for this measured object- Specified by:
isMetricsEnabledin interfaceMeasured- Returns:
trueif metrics are enabled
-
webSocket
public ClientWebSocket webSocket()
Create a WebSocket that is not yet connected to the server.- Returns:
- the client WebSocket
-
connect
public Future<WebSocket> connect(int port, String host, String requestURI)
Connect a 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 a 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 Future<WebSocket> connect(String host, String requestURI)
Connect a WebSocket to the default client port and specified host and relative request URI.- 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 a WebSocket to the default client port and specified host and relative request URI.- Parameters:
host- the hostrequestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
connect
public Future<WebSocket> connect(String requestURI)
Connect a WebSocket to the default client port, default client host and specified, relative request URI.- Parameters:
requestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
rxConnect
public Single<WebSocket> rxConnect(String requestURI)
Connect a WebSocket to the default client port, default client host and specified, relative request URI.- Parameters:
requestURI- the relative URI- Returns:
- a future notified when the WebSocket when connected
-
connect
public Future<WebSocket> connect(WebSocketConnectOptions options)
Connect a 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 a WebSocket with the specified options.- Parameters:
options- the request options- Returns:
- a future notified when the WebSocket when connected
-
shutdown
public Future<Void> shutdown()
Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).- Returns:
- a future completed when shutdown has completed
-
rxShutdown
public Completable rxShutdown()
Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).- Returns:
- a future completed when shutdown has completed
-
close
public Future<Void> close()
Close immediately (shutdown(0, TimeUnit.SECONDS).- Returns:
- a future notified when the client is closed
-
rxClose
public Completable rxClose()
Close immediately (shutdown(0, TimeUnit.SECONDS).- Returns:
- a future notified when the client is closed
-
updateSSLOptions
public Future<Boolean> updateSSLOptions(ClientSSLOptions options)
Update the client with new SSLoptions, the update happens if the options object is valid and different from the existing options object.- Parameters:
options- the new SSL options- Returns:
- a future signaling the update success
-
rxUpdateSSLOptions
public Single<Boolean> rxUpdateSSLOptions(ClientSSLOptions options)
Update the client with new SSLoptions, the update happens if the options object is valid and different from the existing options object.- Parameters:
options- the new SSL options- Returns:
- a future signaling the update success
-
updateSSLOptions
public Future<Boolean> updateSSLOptions(ClientSSLOptions options, boolean force)
Update the client with new SSL
options, the update happens if the options object is valid and different from the existing options object.The
optionsobject is compared using itsequalsmethod against the existing options to prevent an update when the objects are equals since loading options can be costly, this can happen for share TCP servers. When object are equals, settingforcetotrueforces the update.- Parameters:
options- the new SSL optionsforce- force the update when options are equals- Returns:
- a future signaling the update success
-
rxUpdateSSLOptions
public Single<Boolean> rxUpdateSSLOptions(ClientSSLOptions options, boolean force)
Update the client with new SSL
options, the update happens if the options object is valid and different from the existing options object.The
optionsobject is compared using itsequalsmethod against the existing options to prevent an update when the objects are equals since loading options can be costly, this can happen for share TCP servers. When object are equals, settingforcetotrueforces the update.- Parameters:
options- the new SSL optionsforce- force the update when options are equals- Returns:
- a future signaling the update success
-
shutdown
public Future<Void> shutdown(long timeout, TimeUnit unit)
Initiate the client shutdown sequence.- Parameters:
timeout- the amount of time after which all resources are forcibly closedunit- the of the timeout- Returns:
- a future notified when the client is closed
-
rxShutdown
public Completable rxShutdown(long timeout, TimeUnit unit)
Initiate the client shutdown sequence.- Parameters:
timeout- the amount of time after which all resources are forcibly closedunit- the of the timeout- Returns:
- a future notified when the client is closed
-
newInstance
public static WebSocketClient newInstance(WebSocketClient arg)
-
-