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 |
|---|---|
StompClientConnection |
abort(String id)
Aborts a transaction.
|
StompClientConnection |
abort(String id,
Handler<AsyncResult<Frame>> receiptHandler)
Aborts a transaction.
|
StompClientConnection |
abort(String id,
Map<String,String> headers)
Aborts a transaction.
|
StompClientConnection |
abort(String id,
Map<String,String> headers,
Handler<AsyncResult<Frame>> receiptHandler)
Aborts a transaction.
|
StompClientConnection |
ack(String id)
Sends an acknowledgement for a specific message.
|
StompClientConnection |
ack(String id,
Handler<AsyncResult<Frame>> receiptHandler)
Sends an acknowledgement for a specific message.
|
StompClientConnection |
ack(String id,
String txId)
Sends an acknowledgement for the given frame.
|
StompClientConnection |
ack(String id,
String txId,
Handler<AsyncResult<Frame>> receiptHandler)
Sends an acknowledgement for the given frame.
|
StompClientConnection |
beginTX(String id)
Begins a transaction.
|
StompClientConnection |
beginTX(String id,
Handler<AsyncResult<Frame>> receiptHandler)
Begins a transaction.
|
StompClientConnection |
beginTX(String id,
Map<String,String> headers)
Begins a transaction.
|
StompClientConnection |
beginTX(String id,
Map<String,String> headers,
Handler<AsyncResult<Frame>> receiptHandler)
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.
|
StompClientConnection |
commit(String id)
Commits a transaction.
|
StompClientConnection |
commit(String id,
Handler<AsyncResult<Frame>> receiptHandler)
Commits a transaction.
|
StompClientConnection |
commit(String id,
Map<String,String> headers)
Commits a transaction.
|
StompClientConnection |
commit(String id,
Map<String,String> headers,
Handler<AsyncResult<Frame>> receiptHandler)
Commits a transaction.
|
StompClientConnection |
connectionDroppedHandler(Handler<StompClientConnection> handler)
Sets a handler notified when the server does not respond to a
ping request in time. |
StompClientConnection |
disconnect()
Disconnects the client.
|
StompClientConnection |
disconnect(Frame frame)
Disconnects the client.
|
StompClientConnection |
disconnect(Frame frame,
Handler<AsyncResult<Frame>> receiptHandler)
Disconnects the client.
|
StompClientConnection |
disconnect(Handler<AsyncResult<Frame>> receiptHandler)
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.
|
StompClientConnection |
nack(String id)
Sends a non-acknowledgement for the given message.
|
StompClientConnection |
nack(String id,
Handler<AsyncResult<Frame>> receiptHandler)
Sends a non-acknowledgement for the given message.
|
StompClientConnection |
nack(String id,
String txId)
Sends a non-acknowledgement for the given frame.
|
StompClientConnection |
nack(String id,
String txId,
Handler<AsyncResult<Frame>> receiptHandler)
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.
|
StompClientConnection |
send(Frame frame)
Sends the given frame to the server.
|
StompClientConnection |
send(Frame frame,
Handler<AsyncResult<Frame>> receiptHandler)
Sends the given frame to the server.
|
StompClientConnection |
send(Map<String,String> headers,
Buffer body)
Sends a
SEND frame to the server. |
StompClientConnection |
send(Map<String,String> headers,
Buffer body,
Handler<AsyncResult<Frame>> receiptHandler)
Sends a
SEND frame to the server. |
StompClientConnection |
send(String destination,
Buffer body)
Sends a
SEND frame to the server to the given destination. |
StompClientConnection |
send(String destination,
Buffer body,
Handler<AsyncResult<Frame>> receiptHandler)
Sends a
SEND frame to the server to the given destination. |
StompClientConnection |
send(String destination,
Map<String,String> headers,
Buffer body)
Sends a
SEND frame to the server to the given destination. |
StompClientConnection |
send(String destination,
Map<String,String> headers,
Buffer body,
Handler<AsyncResult<Frame>> receiptHandler)
Sends a
SEND frame to the server to the given destination. |
String |
server() |
String |
session() |
StompClientConnection |
subscribe(String destination,
Handler<Frame> handler)
Subscribes to the given destination.
|
StompClientConnection |
subscribe(String destination,
Handler<Frame> handler,
Handler<AsyncResult<String>> receiptHandler)
Subscribes to the given destination.
|
StompClientConnection |
subscribe(String destination,
Map<String,String> headers,
Handler<Frame> handler)
Subscribes to the given destination.
|
StompClientConnection |
subscribe(String destination,
Map<String,String> headers,
Handler<Frame> handler,
Handler<AsyncResult<String>> receiptHandler)
Subscribes to the given destination.
|
String |
toString() |
StompClientConnection |
unsubscribe(String destination)
Un-subscribes from the given destination.
|
StompClientConnection |
unsubscribe(String destination,
Handler<AsyncResult<Frame>> receiptHandler)
Un-subscribes from the given destination.
|
StompClientConnection |
unsubscribe(String destination,
Map<String,String> headers)
Un-subscribes from the given destination.
|
StompClientConnection |
unsubscribe(String destination,
Map<String,String> headers,
Handler<AsyncResult<Frame>> receiptHandler)
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 StompClientConnection send(Map<String,String> headers, Buffer body, Handler<AsyncResult<Frame>> receiptHandler)
SEND frame to the server.headers - the headers, must not be nullbody - the body, may be nullreceiptHandler - the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.StompClientConnectionpublic StompClientConnection send(Map<String,String> headers, Buffer body)
SEND frame to the server.headers - the headers, must not be nullbody - the body, may be nullStompClientConnectionpublic Single<Frame> rxSend(Map<String,String> headers, Buffer body)
SEND frame to the server.headers - the headers, must not be nullbody - the body, may be nullStompClientConnectionpublic StompClientConnection send(String destination, Buffer body, Handler<AsyncResult<Frame>> receiptHandler)
SEND frame to the server to the given destination. The message does not have any other header.destination - the destination, must not be nullbody - the body, may be nullreceiptHandler - the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.StompClientConnectionpublic StompClientConnection 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 nullbody - the body, may be nullStompClientConnectionpublic 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 nullbody - the body, may be nullStompClientConnectionpublic StompClientConnection send(Frame frame, Handler<AsyncResult<Frame>> receiptHandler)
frame - the framereceiptHandler - the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.StompClientConnectionpublic StompClientConnection send(Frame frame)
frame - the frameStompClientConnectionpublic Single<Frame> rxSend(Frame frame)
frame - the frameStompClientConnectionpublic StompClientConnection send(String destination, Map<String,String> headers, Buffer body, Handler<AsyncResult<Frame>> receiptHandler)
SEND frame to the server to the given destination.destination - the destination, must not be nullheaders - the header. The destination header is replaced by the value given to the destination parameterbody - the body, may be nullreceiptHandler - the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.StompClientConnectionpublic StompClientConnection send(String destination, Map<String,String> headers, Buffer body)
SEND frame to the server to the given destination.destination - the destination, must not be nullheaders - the header. The destination header is replaced by the value given to the destination parameterbody - the body, may be nullStompClientConnectionpublic 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 nullheaders - the header. The destination header is replaced by the value given to the destination parameterbody - the body, may be nullStompClientConnectionpublic StompClientConnection subscribe(String destination, Handler<Frame> handler, Handler<AsyncResult<String>> receiptHandler)
destination - the destination, must not be nullhandler - the handler invoked when a message is received on the given destination. Must not be null.receiptHandler - the handler invoked when the RECEIPT frame associated with the subscription has been received. The handler receives the subscription id.StompClientConnectionpublic StompClientConnection subscribe(String destination, Handler<Frame> handler)
destination - the destination, must not be nullhandler - the handler invoked when a message is received on the given destination. Must not be null.StompClientConnectionpublic Single<String> rxSubscribe(String destination, Handler<Frame> handler)
destination - the destination, must not be nullhandler - the handler invoked when a message is received on the given destination. Must not be null.StompClientConnectionpublic StompClientConnection subscribe(String destination, Map<String,String> headers, Handler<Frame> handler, Handler<AsyncResult<String>> receiptHandler)
destination - the destination, must not be nullheaders - 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.receiptHandler - the handler invoked when the RECEIPT frame associated with the subscription has been received. The handler receives the subscription id.StompClientConnectionpublic StompClientConnection subscribe(String destination, Map<String,String> headers, Handler<Frame> handler)
destination - the destination, must not be nullheaders - 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.StompClientConnectionpublic Single<String> rxSubscribe(String destination, Map<String,String> headers, Handler<Frame> handler)
destination - the destination, must not be nullheaders - 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.StompClientConnectionpublic StompClientConnection unsubscribe(String destination, Handler<AsyncResult<Frame>> receiptHandler)
id header).destination - the destinationreceiptHandler - the handler invoked when the RECEIPT frame associated with the un-subscription has been received. The handler receives the sent frame (UNSUBSCRIBE).StompClientConnectionpublic StompClientConnection unsubscribe(String destination)
id header).destination - the destinationStompClientConnectionpublic Single<Frame> rxUnsubscribe(String destination)
id header).destination - the destinationStompClientConnectionpublic StompClientConnection unsubscribe(String destination, Map<String,String> headers, Handler<AsyncResult<Frame>> receiptHandler)
id header, the header value is used. Otherwise the destination is used.destination - the destinationheaders - the headersreceiptHandler - the handler invoked when the RECEIPT frame associated with the un-subscription has been received. The handler receives the sent frame (UNSUBSCRIBE).StompClientConnectionpublic StompClientConnection unsubscribe(String destination, Map<String,String> headers)
id header, the header value is used. Otherwise the destination is used.destination - the destinationheaders - the headersStompClientConnectionpublic 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 headersStompClientConnectionpublic 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 handlerStompClientConnectionpublic StompClientConnection closeHandler(Handler<StompClientConnection> handler)
handler - the handlerStompClientConnectionpublic 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 handlerStompClientConnectionpublic StompClientConnection beginTX(String id, Handler<AsyncResult<Frame>> receiptHandler)
id - the transaction id, must not be nullreceiptHandler - the handler invoked when the RECEIPT frame associated with the transaction begin has been processed by the server. The handler receives the sent frame (BEGIN).StompClientConnectionpublic StompClientConnection beginTX(String id)
id - the transaction id, must not be nullStompClientConnectionpublic Single<Frame> rxBeginTX(String id)
id - the transaction id, must not be nullStompClientConnectionpublic StompClientConnection beginTX(String id, Map<String,String> headers, Handler<AsyncResult<Frame>> receiptHandler)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterreceiptHandler - the handler invoked when the RECEIPT frame associated with the transaction begin has been processed by the server. The handler receives the sent frame (BEGIN).StompClientConnectionpublic StompClientConnection beginTX(String id, Map<String,String> headers)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterStompClientConnectionpublic Single<Frame> rxBeginTX(String id, Map<String,String> headers)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterStompClientConnectionpublic StompClientConnection commit(String id, Handler<AsyncResult<Frame>> receiptHandler)
id - the transaction id, must not be nullreceiptHandler - the handler invoked when the RECEIPT frame associated with the transaction commit has been processed by the server. The handler receives the sent frame (COMMIT).StompClientConnectionpublic StompClientConnection commit(String id)
id - the transaction id, must not be nullStompClientConnectionpublic Single<Frame> rxCommit(String id)
id - the transaction id, must not be nullStompClientConnectionpublic StompClientConnection commit(String id, Map<String,String> headers, Handler<AsyncResult<Frame>> receiptHandler)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterreceiptHandler - the handler invoked when the RECEIPT frame associated with the transaction commit has been processed by the server. The handler receives the sent frame (COMMIT).StompClientConnectionpublic StompClientConnection commit(String id, Map<String,String> headers)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterStompClientConnectionpublic Single<Frame> rxCommit(String id, Map<String,String> headers)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterStompClientConnectionpublic StompClientConnection abort(String id, Handler<AsyncResult<Frame>> receiptHandler)
id - the transaction id, must not be nullreceiptHandler - the handler invoked when the RECEIPT frame associated with the transaction cancellation has been processed by the server. The handler receives the sent frame (ABORT).StompClientConnectionpublic StompClientConnection abort(String id)
id - the transaction id, must not be nullStompClientConnectionpublic Single<Frame> rxAbort(String id)
id - the transaction id, must not be nullStompClientConnectionpublic StompClientConnection abort(String id, Map<String,String> headers, Handler<AsyncResult<Frame>> receiptHandler)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterreceiptHandler - the handler invoked when the RECEIPT frame associated with the transaction cancellation has been processed by the server. The handler receives the sent frame (ABORT).StompClientConnectionpublic StompClientConnection abort(String id, Map<String,String> headers)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterStompClientConnectionpublic Single<Frame> rxAbort(String id, Map<String,String> headers)
id - the transaction id, must not be nullheaders - additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameterStompClientConnectionpublic StompClientConnection disconnect(Handler<AsyncResult<Frame>> receiptHandler)
close() method, this method send the DISCONNECT frame to the
server.receiptHandler - the handler invoked when the RECEIPT frame associated with the disconnection has been processed by the server. The handler receives the sent frame (DISCONNECT).StompClientConnectionpublic StompClientConnection disconnect()
close() method, this method send the DISCONNECT frame to the
server.StompClientConnectionpublic Single<Frame> rxDisconnect()
close() method, this method send the DISCONNECT frame to the
server.StompClientConnectionpublic StompClientConnection disconnect(Frame frame, Handler<AsyncResult<Frame>> receiptHandler)
close() method, this method send the DISCONNECT frame to the
server. This method lets you customize the DISCONNECT frame.frame - the DISCONNECT frame.receiptHandler - the handler invoked when the RECEIPT frame associated with the disconnection has been processed by the server. The handler receives the sent frame (DISCONNECT).RECEIPT frame associated with the sent frame has been receivedpublic StompClientConnection 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 StompClientConnection ack(String id, Handler<AsyncResult<Frame>> receiptHandler)
id parameter is the message id received in the frame.id - the message id of the message to acknowledgereceiptHandler - the handler invoked when the RECEIPT frame associated with the acknowledgment has been processed by the server. The handler receives the sent frame (ACK).StompClientConnectionpublic StompClientConnection ack(String id)
id parameter is the message id received in the frame.id - the message id of the message to acknowledgeStompClientConnectionpublic Single<Frame> rxAck(String id)
id parameter is the message id received in the frame.id - the message id of the message to acknowledgeStompClientConnectionpublic StompClientConnection nack(String id, Handler<AsyncResult<Frame>> receiptHandler)
id parameter is the message id received in the frame.id - the message id of the message to acknowledgereceiptHandler - the handler invoked when the RECEIPT frame associated with the non-acknowledgment has been processed by the server. The handler receives the sent frame (NACK).StompClientConnectionpublic StompClientConnection nack(String id)
id parameter is the message id received in the frame.id - the message id of the message to acknowledgeStompClientConnectionpublic Single<Frame> rxNack(String id)
id parameter is the message id received in the frame.id - the message id of the message to acknowledgeStompClientConnectionpublic StompClientConnection ack(String id, String txId, Handler<AsyncResult<Frame>> receiptHandler)
id - the message id of the message to acknowledgetxId - the transaction idreceiptHandler - the handler invoked when the RECEIPT frame associated with the acknowledgment has been processed by the server. The handler receives the sent frame (ACK).StompClientConnectionpublic StompClientConnection ack(String id, String txId)
id - the message id of the message to acknowledgetxId - the transaction idStompClientConnectionpublic Single<Frame> rxAck(String id, String txId)
id - the message id of the message to acknowledgetxId - the transaction idStompClientConnectionpublic StompClientConnection nack(String id, String txId, Handler<AsyncResult<Frame>> receiptHandler)
id - the message id of the message to acknowledgetxId - the transaction idreceiptHandler - the handler invoked when the RECEIPT frame associated with the non-acknowledgment has been processed by the server. The handler receives the sent frame (NACK).StompClientConnectionpublic StompClientConnection nack(String id, String txId)
id - the message id of the message to acknowledgetxId - the transaction idStompClientConnectionpublic Single<Frame> rxNack(String id, String txId)
id - the message id of the message to acknowledgetxId - the transaction idStompClientConnectionpublic 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 handlerStompClientConnectionpublic 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 handlerStompClientConnectionpublic StompClientConnection exceptionHandler(Handler<Throwable> exceptionHandler)
exceptionHandler - the handlerStompClientConnectionpublic boolean isConnected()
true if the connection is established, false otherwisepublic static StompClientConnection newInstance(StompClientConnection arg)
Copyright © 2022 Eclipse. All rights reserved.