io.vertx.rxjava3.ext.stomp

## Class StompClientConnection

- java.lang.Object
- - io.vertx.rxjava3.ext.stomp.StompClientConnection

-     public class StompClientConnection
      extends Object

  Once a connection to the STOMP server has been made, client receives a `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.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static io.vertx.lang.rx.TypeArg<StompClientConnection>` | `__TYPE_ARG`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StompClientConnection(Object delegate)`
    `StompClientConnection(StompClientConnection delegate)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    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.

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### __TYPE_ARG

          public static final io.vertx.lang.rx.TypeArg<StompClientConnection> __TYPE_ARG

  - ### Constructor Detail

    - #### StompClientConnection

          public StompClientConnection(StompClientConnection delegate)

    - #### StompClientConnection

          public StompClientConnection(Object delegate)

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### getDelegate

          public StompClientConnection getDelegate()

    - #### session

          public String session()

      Returns:
        the session id.

    - #### version

          public String version()

      Returns:
        the STOMP protocol version negotiated with the server.

    - #### close

          public void close()

      Closes the connection without sending the `DISCONNECT` frame.

    - #### server

          public String server()

      Returns:
        the server name.

    - #### send

          public Single<Frame> send(Map<String,String> headers,
                                    Buffer body)

      Sends a `SEND` frame to the server.
      Parameters:
        `headers` - the headers, must not be `null`
        `body` - the body, may be `null`
      Returns:
        the current `StompClientConnection`

    - #### rxSend

          public Single<Frame> rxSend(Map<String,String> headers,
                                      Buffer body)

      Sends a `SEND` frame to the server.
      Parameters:
        `headers` - the headers, must not be `null`
        `body` - the body, may be `null`
      Returns:
        the current `StompClientConnection`

    - #### send

          public Single<Frame> send(String destination,
                                    Buffer body)

      Sends a `SEND` frame to the server to the given destination. The message does not have any other header.
      Parameters:
        `destination` - the destination, must not be `null`
        `body` - the body, may be `null`
      Returns:
        the current `StompClientConnection`

    - #### rxSend

          public Single<Frame> rxSend(String destination,
                                      Buffer body)

      Sends a `SEND` frame to the server to the given destination. The message does not have any other header.
      Parameters:
        `destination` - the destination, must not be `null`
        `body` - the body, may be `null`
      Returns:
        the current `StompClientConnection`

    - #### send

          public Single<Frame> send(Frame frame)

      Sends the given frame to the server.
      Parameters:
        `frame` - the frame
      Returns:
        the current `StompClientConnection`

    - #### rxSend

          public Single<Frame> rxSend(Frame frame)

      Sends the given frame to the server.
      Parameters:
        `frame` - the frame
      Returns:
        the current `StompClientConnection`

    - #### send

          public Single<Frame> send(String destination,
                                    Map<String,String> headers,
                                    Buffer body)

      Sends a `SEND` frame to the server to the given destination.
      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`
      Returns:
        the current `StompClientConnection`

    - #### rxSend

          public Single<Frame> rxSend(String destination,
                                      Map<String,String> headers,
                                      Buffer body)

      Sends a `SEND` frame to the server to the given destination.
      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`
      Returns:
        the current `StompClientConnection`

    - #### subscribe

          public Single<String> subscribe(String destination,
                                          Handler<Frame> handler)

      Subscribes to the given destination. This destination is used as 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`.
      Returns:
        the current `StompClientConnection`

    - #### rxSubscribe

          public Single<String> rxSubscribe(String destination,
                                            Handler<Frame> handler)

      Subscribes to the given destination. This destination is used as 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`.
      Returns:
        the current `StompClientConnection`

    - #### subscribe

          public Single<String> subscribe(String destination,
                                          Map<String,String> headers,
                                          Handler<Frame> handler)

      Subscribes to the given destination.
      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`.
      Returns:
        the current `StompClientConnection`

    - #### rxSubscribe

          public Single<String> rxSubscribe(String destination,
                                            Map<String,String> headers,
                                            Handler<Frame> handler)

      Subscribes to the given destination.
      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`.
      Returns:
        the current `StompClientConnection`

    - #### unsubscribe

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

    - #### rxUnsubscribe

          public Single<Frame> rxUnsubscribe(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).
      Parameters:
        `destination` - the destination
      Returns:
        the current `StompClientConnection`

    - #### unsubscribe

          public Single<Frame> 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.
      Parameters:
        `destination` - the destination
        `headers` - the headers
      Returns:
        the current `StompClientConnection`

    - #### rxUnsubscribe

          public Single<Frame> rxUnsubscribe(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.
      Parameters:
        `destination` - the destination
        `headers` - the headers
      Returns:
        the current `StompClientConnection`

    - #### errorHandler

          public StompClientConnection errorHandler(Handler<Frame> 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`.
      Parameters:
        `handler` - the handler
      Returns:
        the current `StompClientConnection`

    - #### closeHandler

          public StompClientConnection closeHandler(Handler<StompClientConnection> handler)

      Sets a handler notified when the STOMP connection is closed.
      Parameters:
        `handler` - the handler
      Returns:
        the current `StompClientConnection`

    - #### connectionDroppedHandler

          public StompClientConnection connectionDroppedHandler(Handler<StompClientConnection> handler)

      Sets a handler notified when the server does not respond to a `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.
      Parameters:
        `handler` - the handler
      Returns:
        the current `StompClientConnection` receiving the dropped connection.

    - #### pingHandler

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

    - #### beginTX

          public Single<Frame> beginTX(String id)

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

    - #### rxBeginTX

          public Single<Frame> rxBeginTX(String id)

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

    - #### beginTX

          public Single<Frame> beginTX(String id,
                                       Map<String,String> headers)

      Begins a transaction.
      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 @{code id} parameter
      Returns:
        the current `StompClientConnection`

    - #### rxBeginTX

          public Single<Frame> rxBeginTX(String id,
                                         Map<String,String> headers)

      Begins a transaction.
      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 @{code id} parameter
      Returns:
        the current `StompClientConnection`

    - #### commit

          public Single<Frame> commit(String id)

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

    - #### rxCommit

          public Single<Frame> rxCommit(String id)

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

    - #### commit

          public Single<Frame> commit(String id,
                                      Map<String,String> headers)

      Commits a transaction.
      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 @{code id} parameter
      Returns:
        the current `StompClientConnection`

    - #### rxCommit

          public Single<Frame> rxCommit(String id,
                                        Map<String,String> headers)

      Commits a transaction.
      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 @{code id} parameter
      Returns:
        the current `StompClientConnection`

    - #### abort

          public Single<Frame> abort(String id)

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

    - #### rxAbort

          public Single<Frame> rxAbort(String id)

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

    - #### abort

          public Single<Frame> abort(String id,
                                     Map<String,String> headers)

      Aborts a transaction.
      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 @{code id} parameter
      Returns:
        the current `StompClientConnection`

    - #### rxAbort

          public Single<Frame> rxAbort(String id,
                                       Map<String,String> headers)

      Aborts a transaction.
      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 @{code id} parameter
      Returns:
        the current `StompClientConnection`

    - #### disconnect

          public Single<Frame> disconnect()

      Disconnects the client. Unlike the `close()` method, this method send the `DISCONNECT` frame to the server.
      Returns:
        the current `StompClientConnection`

    - #### rxDisconnect

          public Single<Frame> rxDisconnect()

      Disconnects the client. Unlike the `close()` method, this method send the `DISCONNECT` frame to the server.
      Returns:
        the current `StompClientConnection`

    - #### disconnect

          public Single<Frame> disconnect(Frame frame)

      Disconnects the client. Unlike the `close()` method, this method send the `DISCONNECT` frame to the server. This method lets you customize the `DISCONNECT` frame.
      Parameters:
        `frame` - the `DISCONNECT` frame.
      Returns:
        a future resolved with the sent frame when the `RECEIPT` frame associated with the sent frame has been received

    - #### rxDisconnect

          public Single<Frame> rxDisconnect(Frame frame)

      Disconnects the client. Unlike the `close()` method, this method send the `DISCONNECT` frame to the server. This method lets you customize the `DISCONNECT` frame.
      Parameters:
        `frame` - the `DISCONNECT` frame.
      Returns:
        a future resolved with the sent frame when the `RECEIPT` frame associated with the sent frame has been received

    - #### ack

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

    - #### rxAck

          public Single<Frame> rxAck(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.
      Parameters:
        `id` - the message id of the message to acknowledge
      Returns:
        the current `StompClientConnection`

    - #### nack

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

    - #### rxNack

          public Single<Frame> rxNack(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.
      Parameters:
        `id` - the message id of the message to acknowledge
      Returns:
        the current `StompClientConnection`

    - #### ack

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

    - #### rxAck

          public Single<Frame> rxAck(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.
      Parameters:
        `id` - the message id of the message to acknowledge
        `txId` - the transaction id
      Returns:
        the current `StompClientConnection`

    - #### nack

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

    - #### rxNack

          public Single<Frame> rxNack(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.
      Parameters:
        `id` - the message id of the message to acknowledge
        `txId` - the transaction id
      Returns:
        the current `StompClientConnection`

    - #### receivedFrameHandler

          public StompClientConnection receivedFrameHandler(Handler<Frame> handler)

      Configures a received handler that get 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 by the 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.

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

    - #### writingFrameHandler

          public StompClientConnection writingFrameHandler(Handler<Frame> handler)

      Configures a handler notified when a frame is going to be written on the wire. This handler can be used from logging, debugging. The handler can modify the received frame.

      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.

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

    - #### exceptionHandler

          public StompClientConnection exceptionHandler(Handler<Throwable> exceptionHandler)

      Configures the exception handler notified upon TCP-level errors.
      Parameters:
        `exceptionHandler` - the handler
      Returns:
        the current `StompClientConnection`

    - #### isConnected

          public boolean isConnected()

      Returns whether or not the `CONNECTED` frame has been receive meaning that the Stomp connection is established.
      Returns:
        `true` if the connection is established, `false` otherwise

    - #### newInstance

          public static StompClientConnection newInstance(StompClientConnection arg)

Copyright © 2023 Eclipse. All rights reserved.