public class StompClientConnection extends Object
StompClientConnection
, that let
send and receive STOMP frames.
NOTE: This class has been automatically generated from the original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<StompClientConnection> |
__TYPE_ARG |
Constructor and Description |
---|
StompClientConnection(Object delegate) |
StompClientConnection(StompClientConnection delegate) |
Modifier and Type | Method and Description |
---|---|
Single<Frame> |
abort(String id)
Aborts a transaction.
|
Single<Frame> |
abort(String id,
Map<String,String> headers)
Aborts a transaction.
|
Single<Frame> |
ack(String id)
Sends an acknowledgement for a specific message.
|
Single<Frame> |
ack(String id,
String txId)
Sends an acknowledgement for the given frame.
|
Single<Frame> |
beginTX(String id)
Begins a transaction.
|
Single<Frame> |
beginTX(String id,
Map<String,String> headers)
Begins a transaction.
|
void |
close()
Closes the connection without sending the
DISCONNECT frame. |
StompClientConnection |
closeHandler(Handler<StompClientConnection> handler)
Sets a handler notified when the STOMP connection is closed.
|
Single<Frame> |
commit(String id)
Commits a transaction.
|
Single<Frame> |
commit(String id,
Map<String,String> headers)
Commits a transaction.
|
StompClientConnection |
connectionDroppedHandler(Handler<StompClientConnection> handler)
Sets a handler notified when the server does not respond to a
ping request in time. |
Single<Frame> |
disconnect()
Disconnects the client.
|
Single<Frame> |
disconnect(Frame frame)
Disconnects the client.
|
boolean |
equals(Object o) |
StompClientConnection |
errorHandler(Handler<Frame> handler)
Sets a handler notified when an
ERROR frame is received by the client. |
StompClientConnection |
exceptionHandler(Handler<Throwable> exceptionHandler)
Configures the exception handler notified upon TCP-level errors.
|
StompClientConnection |
getDelegate() |
int |
hashCode() |
boolean |
isConnected()
Returns whether or not the `CONNECTED` frame has been receive meaning that the Stomp connection is established.
|
Single<Frame> |
nack(String id)
Sends a non-acknowledgement for the given message.
|
Single<Frame> |
nack(String id,
String txId)
Sends a non-acknowledgement for the given frame.
|
static StompClientConnection |
newInstance(StompClientConnection arg) |
StompClientConnection |
pingHandler(Handler<StompClientConnection> handler)
Sets a handler that let customize the behavior when a ping needs to be sent to the server.
|
StompClientConnection |
receivedFrameHandler(Handler<Frame> handler)
Configures a received handler that get notified when a STOMP frame is received by the client.
|
Single<Frame> |
rxAbort(String id)
Aborts a transaction.
|
Single<Frame> |
rxAbort(String id,
Map<String,String> headers)
Aborts a transaction.
|
Single<Frame> |
rxAck(String id)
Sends an acknowledgement for a specific message.
|
Single<Frame> |
rxAck(String id,
String txId)
Sends an acknowledgement for the given frame.
|
Single<Frame> |
rxBeginTX(String id)
Begins a transaction.
|
Single<Frame> |
rxBeginTX(String id,
Map<String,String> headers)
Begins a transaction.
|
Single<Frame> |
rxCommit(String id)
Commits a transaction.
|
Single<Frame> |
rxCommit(String id,
Map<String,String> headers)
Commits a transaction.
|
Single<Frame> |
rxDisconnect()
Disconnects the client.
|
Single<Frame> |
rxDisconnect(Frame frame)
Disconnects the client.
|
Single<Frame> |
rxNack(String id)
Sends a non-acknowledgement for the given message.
|
Single<Frame> |
rxNack(String id,
String txId)
Sends a non-acknowledgement for the given frame.
|
Single<Frame> |
rxSend(Frame frame)
Sends the given frame to the server.
|
Single<Frame> |
rxSend(Map<String,String> headers,
Buffer body)
Sends a
SEND frame to the server. |
Single<Frame> |
rxSend(String destination,
Buffer body)
Sends a
SEND frame to the server to the given destination. |
Single<Frame> |
rxSend(String destination,
Map<String,String> headers,
Buffer body)
Sends a
SEND frame to the server to the given destination. |
Single<String> |
rxSubscribe(String destination,
Handler<Frame> handler)
Subscribes to the given destination.
|
Single<String> |
rxSubscribe(String destination,
Map<String,String> headers,
Handler<Frame> handler)
Subscribes to the given destination.
|
Single<Frame> |
rxUnsubscribe(String destination)
Un-subscribes from the given destination.
|
Single<Frame> |
rxUnsubscribe(String destination,
Map<String,String> headers)
Un-subscribes from the given destination.
|
Single<Frame> |
send(Frame frame)
Sends the given frame to the server.
|
Single<Frame> |
send(Map<String,String> headers,
Buffer body)
Sends a
SEND frame to the server. |
Single<Frame> |
send(String destination,
Buffer body)
Sends a
SEND frame to the server to the given destination. |
Single<Frame> |
send(String destination,
Map<String,String> headers,
Buffer body)
Sends a
SEND frame to the server to the given destination. |
String |
server() |
String |
session() |
Single<String> |
subscribe(String destination,
Handler<Frame> handler)
Subscribes to the given destination.
|
Single<String> |
subscribe(String destination,
Map<String,String> headers,
Handler<Frame> handler)
Subscribes to the given destination.
|
String |
toString() |
Single<Frame> |
unsubscribe(String destination)
Un-subscribes from the given destination.
|
Single<Frame> |
unsubscribe(String destination,
Map<String,String> headers)
Un-subscribes from the given destination.
|
String |
version() |
StompClientConnection |
writingFrameHandler(Handler<Frame> handler)
Configures a handler notified when a frame is going to be written on the wire.
|
public static final io.vertx.lang.rx.TypeArg<StompClientConnection> __TYPE_ARG
public StompClientConnection(StompClientConnection delegate)
public StompClientConnection(Object delegate)
public StompClientConnection getDelegate()
public String session()
public String version()
public void close()
DISCONNECT
frame.public String server()
public Single<Frame> send(Map<String,String> headers, Buffer body)
SEND
frame to the server.headers
- the headers, must not be null
body
- the body, may be null
StompClientConnection
public Single<Frame> rxSend(Map<String,String> headers, Buffer body)
SEND
frame to the server.headers
- the headers, must not be null
body
- the body, may be null
StompClientConnection
public Single<Frame> send(String destination, Buffer body)
SEND
frame to the server to the given destination. The message does not have any other header.destination
- the destination, must not be null
body
- the body, may be null
StompClientConnection
public Single<Frame> rxSend(String destination, Buffer body)
SEND
frame to the server to the given destination. The message does not have any other header.destination
- the destination, must not be null
body
- the body, may be null
StompClientConnection
public Single<Frame> send(Frame frame)
frame
- the frameStompClientConnection
public Single<Frame> rxSend(Frame frame)
frame
- the frameStompClientConnection
public Single<Frame> send(String destination, Map<String,String> headers, Buffer body)
SEND
frame to the server to the given destination.destination
- the destination, must not be null
headers
- the header. The destination
header is replaced by the value given to the destination
parameterbody
- the body, may be null
StompClientConnection
public Single<Frame> rxSend(String destination, Map<String,String> headers, Buffer body)
SEND
frame to the server to the given destination.destination
- the destination, must not be null
headers
- the header. The destination
header is replaced by the value given to the destination
parameterbody
- the body, may be null
StompClientConnection
public Single<String> subscribe(String destination, Handler<Frame> handler)
destination
- the destination, must not be null
handler
- the handler invoked when a message is received on the given destination. Must not be null
.StompClientConnection
public Single<String> rxSubscribe(String destination, Handler<Frame> handler)
destination
- the destination, must not be null
handler
- the handler invoked when a message is received on the given destination. Must not be null
.StompClientConnection
public Single<String> subscribe(String destination, Map<String,String> headers, Handler<Frame> handler)
destination
- the destination, must not be null
headers
- the headers to configure the subscription. It may contain the ack
header to configure the acknowledgment policy. If the given set of headers contains the id
header, this value is used as subscription id.handler
- the handler invoked when a message is received on the given destination. Must not be null
.StompClientConnection
public Single<String> rxSubscribe(String destination, Map<String,String> headers, Handler<Frame> handler)
destination
- the destination, must not be null
headers
- the headers to configure the subscription. It may contain the ack
header to configure the acknowledgment policy. If the given set of headers contains the id
header, this value is used as subscription id.handler
- the handler invoked when a message is received on the given destination. Must not be null
.StompClientConnection
public Single<Frame> unsubscribe(String destination)
id
header).destination
- the destinationStompClientConnection
public Single<Frame> rxUnsubscribe(String destination)
id
header).destination
- the destinationStompClientConnection
public Single<Frame> unsubscribe(String destination, Map<String,String> headers)
id
header, the header value is used. Otherwise the destination is used.destination
- the destinationheaders
- the headersStompClientConnection
public Single<Frame> rxUnsubscribe(String destination, Map<String,String> headers)
id
header, the header value is used. Otherwise the destination is used.destination
- the destinationheaders
- the headersStompClientConnection
public StompClientConnection errorHandler(Handler<Frame> handler)
ERROR
frame is received by the client. The handler receives the ERROR
frame and a reference on the StompClientConnection
.handler
- the handlerStompClientConnection
public StompClientConnection closeHandler(Handler<StompClientConnection> handler)
handler
- the handlerStompClientConnection
public StompClientConnection connectionDroppedHandler(Handler<StompClientConnection> handler)
ping
request in time. In other
words, this handler is invoked when the heartbeat has detected a connection failure with the server.
The handler can decide to reconnect to the server.handler
- the handlerStompClientConnection
receiving the dropped connection.public StompClientConnection pingHandler(Handler<StompClientConnection> handler)
handler
- the handlerStompClientConnection
public Single<Frame> beginTX(String id)
id
- the transaction id, must not be null
StompClientConnection
public Single<Frame> rxBeginTX(String id)
id
- the transaction id, must not be null
StompClientConnection
public Single<Frame> beginTX(String id, Map<String,String> headers)
id
- the transaction id, must not be null
headers
- additional headers to send to the server. The transaction
header is replaced by the value passed in the @{code id} parameterStompClientConnection
public Single<Frame> rxBeginTX(String id, Map<String,String> headers)
id
- the transaction id, must not be null
headers
- additional headers to send to the server. The transaction
header is replaced by the value passed in the @{code id} parameterStompClientConnection
public Single<Frame> commit(String id)
id
- the transaction id, must not be null
StompClientConnection
public Single<Frame> rxCommit(String id)
id
- the transaction id, must not be null
StompClientConnection
public Single<Frame> commit(String id, Map<String,String> headers)
id
- the transaction id, must not be null
headers
- additional headers to send to the server. The transaction
header is replaced by the value passed in the @{code id} parameterStompClientConnection
public Single<Frame> rxCommit(String id, Map<String,String> headers)
id
- the transaction id, must not be null
headers
- additional headers to send to the server. The transaction
header is replaced by the value passed in the @{code id} parameterStompClientConnection
public Single<Frame> abort(String id)
id
- the transaction id, must not be null
StompClientConnection
public Single<Frame> rxAbort(String id)
id
- the transaction id, must not be null
StompClientConnection
public Single<Frame> abort(String id, Map<String,String> headers)
id
- the transaction id, must not be null
headers
- additional headers to send to the server. The transaction
header is replaced by the value passed in the @{code id} parameterStompClientConnection
public Single<Frame> rxAbort(String id, Map<String,String> headers)
id
- the transaction id, must not be null
headers
- additional headers to send to the server. The transaction
header is replaced by the value passed in the @{code id} parameterStompClientConnection
public Single<Frame> disconnect()
close()
method, this method send the DISCONNECT
frame to the
server.StompClientConnection
public Single<Frame> rxDisconnect()
close()
method, this method send the DISCONNECT
frame to the
server.StompClientConnection
public Single<Frame> disconnect(Frame frame)
close()
method, this method send the DISCONNECT
frame to the
server. This method lets you customize the DISCONNECT
frame.frame
- the DISCONNECT
frame.RECEIPT
frame associated with the sent frame has been receivedpublic Single<Frame> rxDisconnect(Frame frame)
close()
method, this method send the DISCONNECT
frame to the
server. This method lets you customize the DISCONNECT
frame.frame
- the DISCONNECT
frame.RECEIPT
frame associated with the sent frame has been receivedpublic Single<Frame> ack(String id)
id
parameter is the message id received in the frame.id
- the message id of the message to acknowledgeStompClientConnection
public Single<Frame> rxAck(String id)
id
parameter is the message id received in the frame.id
- the message id of the message to acknowledgeStompClientConnection
public Single<Frame> nack(String id)
id
parameter is the message id received in the frame.id
- the message id of the message to acknowledgeStompClientConnection
public Single<Frame> rxNack(String id)
id
parameter is the message id received in the frame.id
- the message id of the message to acknowledgeStompClientConnection
public Single<Frame> ack(String id, String txId)
id
- the message id of the message to acknowledgetxId
- the transaction idStompClientConnection
public Single<Frame> rxAck(String id, String txId)
id
- the message id of the message to acknowledgetxId
- the transaction idStompClientConnection
public Single<Frame> nack(String id, String txId)
id
- the message id of the message to acknowledgetxId
- the transaction idStompClientConnection
public Single<Frame> rxNack(String id, String txId)
id
- the message id of the message to acknowledgetxId
- the transaction idStompClientConnection
public StompClientConnection receivedFrameHandler(Handler<Frame> handler)
Unlike StompClient.receivedFrameHandler(io.vertx.core.Handler<io.vertx.ext.stomp.Frame>)
, the given handler won't receive the CONNECTED
frame. If a received frame handler is set on the StompClient
, it will be used by all
clients connection, so calling this method is useless, except if you want to use a different handler.
handler
- the handlerStompClientConnection
public StompClientConnection writingFrameHandler(Handler<Frame> handler)
If a writing frame handler is set on the StompClient
, it will be used by all
clients connection, so calling this method is useless, except if you want to use a different handler.
handler
- the handlerStompClientConnection
public StompClientConnection exceptionHandler(Handler<Throwable> exceptionHandler)
exceptionHandler
- the handlerStompClientConnection
public boolean isConnected()
true
if the connection is established, false
otherwisepublic static StompClientConnection newInstance(StompClientConnection arg)
Copyright © 2022 Eclipse. All rights reserved.