Once a connection to the STOMP server has been made, client receives a StompClientConnection, that let send and receive STOMP frames.
| Constructor and description |
|---|
StompClientConnection
(Object delegate) |
| Type | Name and description |
|---|---|
StompClientConnection |
abort(String id)Aborts a transaction. |
StompClientConnection |
abort(String id, Handler<Map<String, Object>> receiptHandler)Aborts a transaction. |
StompClientConnection |
abort(String id, Map<String, String> headers)Aborts a transaction. |
StompClientConnection |
abort(String id, Map<String, String> headers, Handler<Map<String, Object>> receiptHandler)Aborts a transaction. |
StompClientConnection |
ack(String id)Sends an acknowledgement for a specific message. |
StompClientConnection |
ack(String id, Handler<Map<String, Object>> 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<Map<String, Object>> receiptHandler)Sends an acknowledgement for the given frame. |
StompClientConnection |
beginTX(String id, Handler<Map<String, Object>> receiptHandler)Begins a transaction. |
StompClientConnection |
beginTX(String id)Begins a transaction. |
StompClientConnection |
beginTX(String id, Map<String, String> headers)Begins a transaction. |
StompClientConnection |
beginTX(String id, Map<String, String> headers, Handler<Map<String, Object>> 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<Map<String, Object>> receiptHandler)Commits a transaction. |
StompClientConnection |
commit(String id, Map<String, String> headers)Commits a transaction. |
StompClientConnection |
commit(String id, Map<String, String> headers, Handler<Map<String, Object>> receiptHandler)Commits a transaction. |
StompClientConnection |
disconnect()Disconnects the client. |
StompClientConnection |
disconnect(Handler<Map<String, Object>> receiptHandler)Disconnects the client. |
StompClientConnection |
disconnect(Map<String, Object> frame)Disconnects the client. |
StompClientConnection |
disconnect(Map<String, Object> frame, Handler<Map<String, Object>> receiptHandler)Disconnects the client. |
StompClientConnection |
errorHandler(Handler<Map<String, Object>> handler)Sets a handler notified when an ERROR frame is received by the client. |
Object |
getDelegate() |
StompClientConnection |
nack(String id)Sends a non-acknowledgement for the given message. |
StompClientConnection |
nack(String id, Handler<Map<String, Object>> 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<Map<String, Object>> receiptHandler)Sends a non-acknowledgement for the given frame. |
StompClientConnection |
pingHandler(Handler<StompClientConnection> handler)Sets a handler that let customize the behavior when a ping needs to be sent 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<Map<String, Object>> 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<Map<String, Object>> receiptHandler)Sends a SEND frame to the server to the given destination. |
StompClientConnection |
send(Map<String, Object> frame = [:])Sends the given frame to the server. |
StompClientConnection |
send(Map<String, Object> frame = [:], Handler<Map<String, Object>> receiptHandler)Sends the given frame to the server. |
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<Map<String, Object>> receiptHandler)Sends a SEND frame to the server to the given destination. |
String |
server()
|
String |
session()
|
String |
subscribe(String destination, Handler<Map<String, Object>> handler)Subscribes to the given destination. |
String |
subscribe(String destination, Handler<Map<String, Object>> handler, Handler<Map<String, Object>> receiptHandler)Subscribes to the given destination. |
String |
subscribe(String destination, Map<String, String> headers, Handler<Map<String, Object>> handler)Subscribes to the given destination. |
String |
subscribe(String destination, Map<String, String> headers, Handler<Map<String, Object>> handler, Handler<Map<String, Object>> receiptHandler)Subscribes to the given destination. |
StompClientConnection |
unsubscribe(String destination)Un-subscribes from the given destination. |
StompClientConnection |
unsubscribe(String destination, Handler<Map<String, Object>> 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<Map<String, Object>> receiptHandler)Un-subscribes from the given destination. |
String |
version()
|
Aborts a transaction.
id - the transaction id, must not be nullAborts a transaction.
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).Aborts a transaction. @{code id} parameter
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 theAborts a transaction. @{code id} parameter
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 thereceiptHandler - 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). Sends an acknowledgement for a specific message. It means that the message has been handled and processed by the
client. The id parameter is the message id received in the frame.
id - the message id of the message to acknowledge Sends an acknowledgement for a specific message. It means that the message has been handled and processed by the
client. The 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).Sends an acknowledgement for the given frame. It means that the frame has been handled and processed by the client. The sent acknowledgement is part of the transaction identified by the given id.
id - the message id of the message to acknowledgetxId - the transaction idSends an acknowledgement for the given frame. It means that the frame has been handled and processed by the client. The sent acknowledgement is part of the transaction identified by the given id.
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).Begins a transaction.
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).Begins a transaction.
id - the transaction id, must not be nullBegins a transaction. @{code id} parameter
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 theBegins a transaction. @{code id} parameter
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 thereceiptHandler - 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). Closes the connection without sending the DISCONNECT frame.
Sets a handler notified when the STOMP connection is closed.
handler - the handlerCommits a transaction.
id - the transaction id, must not be nullCommits a transaction.
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).Commits a transaction. @{code id} parameter
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 theCommits a transaction. @{code id} parameter
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 thereceiptHandler - 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). Disconnects the client. Unlike the StompClientConnection.close method, this method send the DISCONNECT frame to the
server.
Disconnects the client. Unlike the StompClientConnection.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). Disconnects the client. Unlike the StompClientConnection.close method, this method send the DISCONNECT frame to the
server. This method lets you customize the DISCONNECT frame.
frame - the DISCONNECT frame. (see Frame) Disconnects the client. Unlike the StompClientConnection.close method, this method send the DISCONNECT frame to the
server. This method lets you customize the DISCONNECT frame.
frame - the DISCONNECT frame. (see 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). Sets a handler notified when an ERROR frame is received by the client. The handler receives the ERROR frame and a reference on the StompClientConnection.
handler - the handler Sends a non-acknowledgement for the given message. It means that the message has not been handled by the client.
The id parameter is the message id received in the frame.
id - the message id of the message to acknowledge Sends a non-acknowledgement for the given message. It means that the message has not been handled by the client.
The 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).Sends a non-acknowledgement for the given frame. It means that the frame has not been handled by the client. The sent non-acknowledgement is part of the transaction identified by the given id.
id - the message id of the message to acknowledgetxId - the transaction idSends a non-acknowledgement for the given frame. It means that the frame has not been handled by the client. The sent non-acknowledgement is part of the transaction identified by the given id.
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).Sets a handler that let customize the behavior when a ping needs to be sent to the server. Be aware that changing the default behavior may break the compliance with the STOMP specification.
handler - the handler Sends a SEND frame to the server.
headers - the headers, must not be nullbody - the body, may be null Sends a 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. Sends a 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 null Sends a 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.Sends the given frame to the server.
frame - the frame (see Frame)Sends the given frame to the server.
frame - the frame (see Frame)receiptHandler - the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame. Sends a 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 null Sends a 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.
Subscribes to the given destination. This destination is used as subscription id.
destination - the destination, must not be nullhandler - the handler invoked when a message is received on the given destination. Must not be null.Subscribes to the given destination. This destination is used as subscription id.
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 sent frame (SUBSCRIBE).Subscribes to the given destination.
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.Subscribes to the given destination.
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 sent frame (SUBSCRIBE). Un-subscribes from the given destination. This method only works if the subscription did not specifies a
subscription id (using the id header).
destination - the destination Un-subscribes from the given destination. This method only works if the subscription did not specifies a
subscription id (using the 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). Un-subscribes from the given destination. This method computes the subscription id as follows. If the given
headers contains the id header, the header value is used. Otherwise the destination is used.
destination - the destinationheaders - the headers Un-subscribes from the given destination. This method computes the subscription id as follows. If the given
headers contains the 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).
io.vertx:vertx-stomp:3.1.0