Package io.vertx.reactivex.core.http
Class WebSocketClient
- java.lang.Object
-
- io.vertx.reactivex.core.http.WebSocketClient
-
-
Field Summary
Fields Modifier and Type Field Description static 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 void
close()
Close the client.void
close(Handler<AsyncResult<Void>> handler)
Close the client.void
connect(int port, String host, String requestURI)
Connect a WebSocket to the specified port, host and relative request URIvoid
connect(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the specified port, host and relative request URIvoid
connect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.void
connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified options.void
connect(String requestURI)
Connect a WebSocket to the default client port, default client host and specified, relative request URI.void
connect(String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the default client port, default client host and specified, relative request URI.void
connect(String host, String requestURI)
Connect a WebSocket to the default client port and specified host and relative request URI.void
connect(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the default client port and specified host and relative request URI.boolean
equals(Object o)
WebSocketClient
getDelegate()
int
hashCode()
boolean
isMetricsEnabled()
Whether the metrics are enabled for this measured objectstatic WebSocketClient
newInstance(WebSocketClient arg)
io.reactivex.Completable
rxClose()
Close the client.io.reactivex.Single<WebSocket>
rxConnect(int port, String host, String requestURI)
Connect a WebSocket to the specified port, host and relative request URIio.reactivex.Single<WebSocket>
rxConnect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.io.reactivex.Single<WebSocket>
rxConnect(String requestURI)
Connect a WebSocket to the default client port, default client host and specified, relative request URI.io.reactivex.Single<WebSocket>
rxConnect(String host, String requestURI)
Connect a WebSocket to the default client port and specified host and relative request URI.io.reactivex.Single<Boolean>
rxUpdateSSLOptions(SSLOptions options)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).io.reactivex.Single<Boolean>
rxUpdateSSLOptions(SSLOptions options, boolean force)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).String
toString()
void
updateSSLOptions(SSLOptions options)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).void
updateSSLOptions(SSLOptions options, boolean force)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).void
updateSSLOptions(SSLOptions options, boolean force, Handler<AsyncResult<Boolean>> handler)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).void
updateSSLOptions(SSLOptions options, Handler<AsyncResult<Boolean>> handler)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).ClientWebSocket
webSocket()
Create a WebSocket that is not yet connected to the server.
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<WebSocketClient> __TYPE_ARG
-
-
Constructor Detail
-
WebSocketClient
public WebSocketClient(WebSocketClient delegate)
-
WebSocketClient
public WebSocketClient(Object delegate)
-
-
Method Detail
-
getDelegate
public WebSocketClient getDelegate()
- Specified by:
getDelegate
in interfaceMeasured
-
isMetricsEnabled
public boolean isMetricsEnabled()
Whether the metrics are enabled for this measured object- Specified by:
isMetricsEnabled
in interfaceMeasured
- Returns:
true
if metrics are enabled
-
webSocket
public ClientWebSocket webSocket()
Create a WebSocket that is not yet connected to the server.- Returns:
- the client WebSocket
-
connect
public void connect(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the specified port, host and relative request URI- Parameters:
port
- the porthost
- the hostrequestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connected
-
connect
public void 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
-
rxConnect
public io.reactivex.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:
-
connect
public void connect(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the default client port and specified host and relative request URI.- Parameters:
host
- the hostrequestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connected
-
connect
public void 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
-
rxConnect
public io.reactivex.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:
-
connect
public void connect(String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the default client port, default client host and specified, relative request URI.- Parameters:
requestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connected
-
connect
public void connect(String requestURI)
Connect a WebSocket to the default client port, default client host and specified, relative request URI.- Parameters:
requestURI
- the relative URI
-
rxConnect
public io.reactivex.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:
-
connect
public void connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified options.- Parameters:
options
- the request optionshandler
-
-
connect
public void connect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.- Parameters:
options
- the request options
-
rxConnect
public io.reactivex.Single<WebSocket> rxConnect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.- Parameters:
options
- the request options- Returns:
-
updateSSLOptions
public void updateSSLOptions(SSLOptions options, Handler<AsyncResult<Boolean>> handler)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).- Parameters:
options
- the new SSL optionshandler
- the update handler
-
updateSSLOptions
public void updateSSLOptions(SSLOptions options)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).- Parameters:
options
- the new SSL options
-
rxUpdateSSLOptions
public io.reactivex.Single<Boolean> rxUpdateSSLOptions(SSLOptions options)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).- Parameters:
options
- the new SSL options- Returns:
-
updateSSLOptions
public void updateSSLOptions(SSLOptions options, boolean force, Handler<AsyncResult<Boolean>> handler)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).- Parameters:
options
- the new SSL optionsforce
- force the update when options are equalshandler
- the update handler
-
updateSSLOptions
public void updateSSLOptions(SSLOptions options, boolean force)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).- Parameters:
options
- the new SSL optionsforce
- force the update when options are equals
-
rxUpdateSSLOptions
public io.reactivex.Single<Boolean> rxUpdateSSLOptions(SSLOptions options, boolean force)
LikeupdateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>)
but supplying a handler that will be called when the update happened (or has failed).- Parameters:
options
- the new SSL optionsforce
- force the update when options are equals- Returns:
-
close
public void close(Handler<AsyncResult<Void>> handler)
Close the client. Closing will close down any pooled connections. Clients should always be closed after use.- Parameters:
handler
-
-
close
public void close()
Close the client. Closing will close down any pooled connections. Clients should always be closed after use.
-
rxClose
public io.reactivex.Completable rxClose()
Close the client. Closing will close down any pooled connections. Clients should always be closed after use.- Returns:
-
newInstance
public static WebSocketClient newInstance(WebSocketClient arg)
-
-