Package io.vertx.reactivex.ext.stomp
Class StompClient
- java.lang.Object
-
- io.vertx.reactivex.ext.stomp.StompClient
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<StompClient>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description StompClient(StompClient delegate)
StompClient(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Closes the client.StompClient
connect()
Connects to the server using the host and port configured in the client's options.StompClient
connect(int port, String host)
Connects to the server.StompClient
connect(int port, String host, Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server.StompClient
connect(int port, String host, NetClient net)
Connects to the server.StompClient
connect(int port, String host, NetClient net, Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server.StompClient
connect(Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server using the host and port configured in the client's options.StompClient
connect(NetClient net)
Connects to the server.StompClient
connect(NetClient net, Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server.static StompClient
create(Vertx vertx)
Creates aStompClient
using the default implementation.static StompClient
create(Vertx vertx, StompClientOptions options)
Creates aStompClient
using the default implementation.boolean
equals(Object o)
StompClient
errorFrameHandler(Handler<Frame> handler)
A general error frame handler.StompClient
exceptionHandler(Handler<Throwable> handler)
Sets an exception handler notified for TCP-level errors.StompClient
getDelegate()
int
hashCode()
boolean
isClosed()
static StompClient
newInstance(StompClient arg)
StompClientOptions
options()
StompClient
receivedFrameHandler(Handler<Frame> handler)
Configures a received handler that gets notified when a STOMP frame is received by the client.io.reactivex.Single<StompClientConnection>
rxConnect()
Connects to the server using the host and port configured in the client's options.io.reactivex.Single<StompClientConnection>
rxConnect(int port, String host)
Connects to the server.io.reactivex.Single<StompClientConnection>
rxConnect(int port, String host, NetClient net)
Connects to the server.io.reactivex.Single<StompClientConnection>
rxConnect(NetClient net)
Connects to the server.String
toString()
Vertx
vertx()
StompClient
writingFrameHandler(Handler<Frame> handler)
Configures a writing handler that gets notified when a STOMP frame is written on the wire.
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<StompClient> __TYPE_ARG
-
-
Constructor Detail
-
StompClient
public StompClient(StompClient delegate)
-
StompClient
public StompClient(Object delegate)
-
-
Method Detail
-
getDelegate
public StompClient getDelegate()
-
create
public static StompClient create(Vertx vertx)
Creates aStompClient
using the default implementation.- Parameters:
vertx
- the vert.x instance to use- Returns:
- the created
StompClient
-
create
public static StompClient create(Vertx vertx, StompClientOptions options)
Creates aStompClient
using the default implementation.- Parameters:
vertx
- the vert.x instance to useoptions
- the options- Returns:
- the created
StompClient
-
connect
public StompClient connect(int port, String host, Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server.- Parameters:
port
- the server porthost
- the server hostresultHandler
- handler called with the connection result- Returns:
- the current
StompClient
-
connect
public StompClient connect(int port, String host)
Connects to the server.- Parameters:
port
- the server porthost
- the server host- Returns:
- the current
StompClient
-
rxConnect
public io.reactivex.Single<StompClientConnection> rxConnect(int port, String host)
Connects to the server.- Parameters:
port
- the server porthost
- the server host- Returns:
- the current
StompClient
-
connect
public StompClient connect(NetClient net, Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server.- Parameters:
net
- the NET client to useresultHandler
- handler called with the connection result- Returns:
- the current
StompClient
-
connect
public StompClient connect(NetClient net)
Connects to the server.- Parameters:
net
- the NET client to use- Returns:
- the current
StompClient
-
rxConnect
public io.reactivex.Single<StompClientConnection> rxConnect(NetClient net)
Connects to the server.- Parameters:
net
- the NET client to use- Returns:
- the current
StompClient
-
connect
public StompClient connect(int port, String host, NetClient net, Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server.- Parameters:
port
- the server porthost
- the server hostnet
- the NET client to useresultHandler
- handler called with the connection result- Returns:
- the current
StompClient
-
connect
public StompClient connect(int port, String host, NetClient net)
Connects to the server.- Parameters:
port
- the server porthost
- the server hostnet
- the NET client to use- Returns:
- the current
StompClient
-
rxConnect
public io.reactivex.Single<StompClientConnection> rxConnect(int port, String host, NetClient net)
Connects to the server.- Parameters:
port
- the server porthost
- the server hostnet
- the NET client to use- Returns:
- the current
StompClient
-
connect
public StompClient connect(Handler<AsyncResult<StompClientConnection>> resultHandler)
Connects to the server using the host and port configured in the client's options.- Parameters:
resultHandler
- handler called with the connection result. A failure will be sent to the handler if a TCP level issue happen before the `CONNECTED` frame is received. Afterwards, theexceptionHandler(io.vertx.core.Handler<java.lang.Throwable>)
is called.- Returns:
- the current
StompClient
-
connect
public StompClient connect()
Connects to the server using the host and port configured in the client's options.- Returns:
- the current
StompClient
-
rxConnect
public io.reactivex.Single<StompClientConnection> rxConnect()
Connects to the server using the host and port configured in the client's options.- Returns:
- the current
StompClient
-
receivedFrameHandler
public StompClient receivedFrameHandler(Handler<Frame> handler)
Configures a received handler that gets notified when a STOMP frame is received by the client. This handler can be used for logging, debugging or ad-hoc behavior. The frame can still be modified at the time.When a connection is created, the handler is used as
StompClientConnection.receivedFrameHandler(io.vertx.core.Handler<io.vertx.ext.stomp.Frame>)
.- Parameters:
handler
- the handler- Returns:
- the current
StompClient
-
writingFrameHandler
public StompClient writingFrameHandler(Handler<Frame> handler)
Configures a writing handler that gets notified when a STOMP frame is written on the wire. This handler can be used for logging, debugging or ad-hoc behavior. The frame can still be modified at the time.When a connection is created, the handler is used as
StompClientConnection.writingFrameHandler(io.vertx.core.Handler<io.vertx.ext.stomp.Frame>)
.- Parameters:
handler
- the handler- Returns:
- the current
StompClient
-
errorFrameHandler
public StompClient errorFrameHandler(Handler<Frame> handler)
A general error frame handler. It can be used to catchERROR
frame emitted during the connection process (wrong authentication). This error handler will be pass to allStompClientConnection
created from this client. Obviously, the client can override it when the connection is established.- Parameters:
handler
- the handler- Returns:
- the current
StompClient
-
exceptionHandler
public StompClient exceptionHandler(Handler<Throwable> handler)
Sets an exception handler notified for TCP-level errors.- Parameters:
handler
- the handler- Returns:
- the current
StompClient
-
close
public void close()
Closes the client.
-
options
public StompClientOptions options()
- Returns:
- the client's options.
-
vertx
public Vertx vertx()
- Returns:
- the vert.x instance used by the client.
-
isClosed
public boolean isClosed()
- Returns:
- whether or not the client is connected to the server.
-
newInstance
public static StompClient newInstance(StompClient arg)
-
-