Package: io.vertx.groovy.ext.stomp

## [Groovy] Class StompClientConnection

- io.vertx.groovy.ext.stomp.StompClientConnection

- Once a connection to the STOMP server has been made, client receives a StompClientConnection, that let send and receive STOMP frames.

- - ### Constructor Summary

    Constructors
    Constructor and description
    `StompClientConnection (Object delegate)`

  - ### Methods Summary

    Methods
    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()` Returns: the server name.
    `String` | `session()` Returns: the session id.
    `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()` Returns: the STOMP protocol version negotiated with the server.

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- - ### Constructor Detail

    - #### StompClientConnection(Object delegate)

  - ### Method Detail

    - #### StompClientConnection abort(String id)

      Aborts a transaction.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the transaction id, must not be `null`

    - #### StompClientConnection abort(String id, Handler<Map<String, Object>> receiptHandler)

      Aborts a transaction.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the transaction id, must not be `null`
        `receiptHandler` - 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`).

    - #### StompClientConnection abort(String id, Map<String, String> headers)

      Aborts a transaction. @{code id} parameter

      Returns:
        the current StompClientConnection
      Parameters:
        `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

    - #### StompClientConnection abort(String id, Map<String, String> headers, Handler<Map<String, Object>> receiptHandler)

      Aborts a transaction. @{code id} parameter

      Returns:
        the current StompClientConnection
      Parameters:
        `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
        `receiptHandler` - 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`).

    - #### StompClientConnection ack(String id)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge

    - #### StompClientConnection ack(String id, Handler<Map<String, Object>> receiptHandler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the acknowledgment has been processed by the server. The handler receives the sent frame (`ACK`).

    - #### StompClientConnection ack(String id, String txId)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge
        `txId` - the transaction id

    - #### StompClientConnection ack(String id, String txId, Handler<Map<String, Object>> receiptHandler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge
        `txId` - the transaction id
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the acknowledgment has been processed by the server. The handler receives the sent frame (`ACK`).

    - #### StompClientConnection beginTX(String id, Handler<Map<String, Object>> receiptHandler)

      Begins a transaction.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the transaction id, must not be `null`
        `receiptHandler` - 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`).

    - #### StompClientConnection beginTX(String id)

      Begins a transaction.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the transaction id, must not be `null`

    - #### StompClientConnection beginTX(String id, Map<String, String> headers)

      Begins a transaction. @{code id} parameter

      Returns:
        the current StompClientConnection
      Parameters:
        `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

    - #### StompClientConnection beginTX(String id, Map<String, String> headers, Handler<Map<String, Object>> receiptHandler)

      Begins a transaction. @{code id} parameter

      Returns:
        the current StompClientConnection
      Parameters:
        `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
        `receiptHandler` - 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`).

    - #### 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.

      Returns:
        the current StompClientConnection
      Parameters:
        `handler` - the handler

    - #### StompClientConnection commit(String id)

      Commits a transaction.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the transaction id, must not be `null`

    - #### StompClientConnection commit(String id, Handler<Map<String, Object>> receiptHandler)

      Commits a transaction.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the transaction id, must not be `null`
        `receiptHandler` - 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`).

    - #### StompClientConnection commit(String id, Map<String, String> headers)

      Commits a transaction. @{code id} parameter

      Returns:
        the current StompClientConnection
      Parameters:
        `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

    - #### StompClientConnection commit(String id, Map<String, String> headers, Handler<Map<String, Object>> receiptHandler)

      Commits a transaction. @{code id} parameter

      Returns:
        the current StompClientConnection
      Parameters:
        `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
        `receiptHandler` - 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`).

    - #### StompClientConnection disconnect()

      Disconnects the client. Unlike the StompClientConnection.close method, this method send the `DISCONNECT` frame to the server.

      Returns:
        the current StompClientConnection

    - #### StompClientConnection disconnect(Handler<Map<String, Object>> receiptHandler)

      Disconnects the client. Unlike the StompClientConnection.close method, this method send the `DISCONNECT` frame to the server.

      Returns:
        the current StompClientConnection
      Parameters:
        `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`).

    - #### StompClientConnection disconnect(Map<String, Object> 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.

      Returns:
        the current StompClientConnection
      Parameters:
        `frame` - the `DISCONNECT` frame. (see Frame)

    - #### StompClientConnection disconnect(Map<String, Object> frame, Handler<Map<String, Object>> receiptHandler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `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`).

    - #### StompClientConnection errorHandler(Handler<Map<String, Object>> handler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `handler` - the handler

    - #### Object getDelegate()

    - #### StompClientConnection nack(String id)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge

    - #### StompClientConnection nack(String id, Handler<Map<String, Object>> receiptHandler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge
        `receiptHandler` - 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`).

    - #### StompClientConnection nack(String id, String txId)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge
        `txId` - the transaction id

    - #### StompClientConnection nack(String id, String txId, Handler<Map<String, Object>> receiptHandler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `id` - the message id of the message to acknowledge
        `txId` - the transaction id
        `receiptHandler` - 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`).

    - #### StompClientConnection pingHandler(Handler<StompClientConnection> handler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `handler` - the handler

    - #### StompClientConnection send(Map<String, String> headers, Buffer body)

      Sends a `SEND` frame to the server.

      Returns:
        the current StompClientConnection
      Parameters:
        `headers` - the headers, must not be `null`
        `body` - the body, may be `null`

    - #### StompClientConnection send(Map<String, String> headers, Buffer body, Handler<Map<String, Object>> receiptHandler)

      Sends a `SEND` frame to the server.

      Returns:
        the current StompClientConnection
      Parameters:
        `headers` - the headers, must not be `null`
        `body` - the body, may be `null`
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the sent frame has been received. The handler receives the sent frame.

    - #### StompClientConnection send(String destination, Buffer body)

      Sends a `SEND` frame to the server to the given destination. The message does not have any other header.

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination, must not be `null`
        `body` - the body, may be `null`

    - #### StompClientConnection send(String destination, Buffer body, Handler<Map<String, Object>> receiptHandler)

      Sends a `SEND` frame to the server to the given destination. The message does not have any other header.

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination, must not be `null`
        `body` - the body, may be `null`
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the sent frame has been received. The handler receives the sent frame.

    - #### StompClientConnection send(Map<String, Object> frame = [:])

      Sends the given frame to the server.

      Returns:
        the current StompClientConnection
      Parameters:
        `frame` - the frame (see Frame)

    - #### StompClientConnection send(Map<String, Object> frame = [:], Handler<Map<String, Object>> receiptHandler)

      Sends the given frame to the server.

      Returns:
        the current StompClientConnection
      Parameters:
        `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.

    - #### StompClientConnection send(String destination, Map<String, String> headers, Buffer body)

      Sends a `SEND` frame to the server to the given destination.

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination, must not be `null`
        `headers` - the header. The `destination` header is replaced by the value given to the `destination` parameter
        `body` - the body, may be `null`

    - #### 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.

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination, must not be `null`
        `headers` - the header. The `destination` header is replaced by the value given to the `destination` parameter
        `body` - the body, may be `null`
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the sent frame has been received. The handler receives the sent frame.

    - #### String server()

      Returns:
        the server name.

    - #### String session()

      Returns:
        the session id.

    - #### String subscribe(String destination, Handler<Map<String, Object>> handler)

      Subscribes to the given destination. This destination is used as subscription id.

      Returns:
        the subscription id.
      Parameters:
        `destination` - the destination, must not be `null`
        `handler` - the handler invoked when a message is received on the given destination. Must not be `null`.

    - #### String subscribe(String destination, Handler<Map<String, Object>> handler, Handler<Map<String, Object>> receiptHandler)

      Subscribes to the given destination. This destination is used as subscription id.

      Returns:
        the subscription id.
      Parameters:
        `destination` - the destination, must not be `null`
        `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`).

    - #### String subscribe(String destination, Map<String, String> headers, Handler<Map<String, Object>> handler)

      Subscribes to the given destination.

      Returns:
        the subscription id, which can either be the destination or the id set in the headers.
      Parameters:
        `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`.

    - #### String subscribe(String destination, Map<String, String> headers, Handler<Map<String, Object>> handler, Handler<Map<String, Object>> receiptHandler)

      Subscribes to the given destination.

      Returns:
        the subscription id, which can either be the destination or the id set in the headers.
      Parameters:
        `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`.
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the subscription has been received. The handler receives the sent frame (`SUBSCRIBE`).

    - #### StompClientConnection unsubscribe(String destination)

      Un-subscribes from the given destination. This method only works if the subscription did not specifies a subscription id (using the `id` header).

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination

    - #### StompClientConnection unsubscribe(String destination, Handler<Map<String, Object>> receiptHandler)

      Un-subscribes from the given destination. This method only works if the subscription did not specifies a subscription id (using the `id` header).

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the un-subscription has been received. The handler receives the sent frame (`UNSUBSCRIBE`).

    - #### StompClientConnection unsubscribe(String destination, Map<String, String> 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.

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination
        `headers` - the headers

    - #### StompClientConnection unsubscribe(String destination, Map<String, String> headers, Handler<Map<String, Object>> receiptHandler)

      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.

      Returns:
        the current StompClientConnection
      Parameters:
        `destination` - the destination
        `headers` - the headers
        `receiptHandler` - the handler invoked when the `RECEIPT` frame associated with the un-subscription has been received. The handler receives the sent frame (`UNSUBSCRIBE`).

    - #### String version()

      Returns:
        the STOMP protocol version negotiated with the server.