Package io.vertx.mutiny.amqp

Class AmqpConnection

  • public class AmqpConnection
extends Object
    Once connected to the broker or router, you get a connection. This connection is automatically opened.

    NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

    • Constructor Detail

      • AmqpConnection

        public AmqpConnection​(io.vertx.amqp.AmqpConnection delegate)

      • AmqpConnection

        public AmqpConnection​(Object delegate)

    • Method Detail

      • getDelegate

        public io.vertx.amqp.AmqpConnection getDelegate()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • close

        public io.smallrye.mutiny.Uni<Void> close()
        Closes the AMQP connection, i.e. allows the Close frame to be emitted.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • closeAndAwait

        public Void closeAndAwait()
        Blocking variant of close().

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Returns:
        the Void instance produced by the operation.

      • closeAndForget

        public AmqpConnection closeAndForget()
        Variant of close() that ignores the result of the operation.

        This method subscribes on the result of close(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from close() but you don't need to compose it with other operations.

        Returns:
        the instance of AmqpConnection to chain method calls.

      • createReceiver

        public io.smallrye.mutiny.Uni<AmqpReceiver> createReceiver​(String address)
        Creates a receiver used to consume messages from the given address. The receiver has no handler and won't start receiving messages until a handler is explicitly configured.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        address - The source address to attach the consumer to, must not be null
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • createReceiverAndAwait

        public AmqpReceiver createReceiverAndAwait​(String address)
        Blocking variant of createReceiver(String).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        address - The source address to attach the consumer to, must not be null
        Returns:
        the AmqpReceiver instance produced by the operation.

      • createReceiverAndForget

        public AmqpConnection createReceiverAndForget​(String address)
        Variant of createReceiver(String) that ignores the result of the operation.

        This method subscribes on the result of createReceiver(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from createReceiver(String) but you don't need to compose it with other operations.

        Parameters:
        address - The source address to attach the consumer to, must not be null
        Returns:
        the instance of AmqpConnection to chain method calls.

      • createReceiver

        public io.smallrye.mutiny.Uni<AmqpReceiver> createReceiver​(String address,
                                                           io.vertx.amqp.AmqpReceiverOptions receiverOptions)
        Creates a receiver used to consumer messages from the given address.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        address - The source address to attach the consumer to.
        receiverOptions - The options for this receiver.
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • createReceiverAndAwait

        public AmqpReceiver createReceiverAndAwait​(String address,
                                           io.vertx.amqp.AmqpReceiverOptions receiverOptions)
        Blocking variant of createReceiver(String,AmqpReceiverOptions).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        address - The source address to attach the consumer to.
        receiverOptions - The options for this receiver.
        Returns:
        the AmqpReceiver instance produced by the operation.

      • createDynamicReceiver

        public io.smallrye.mutiny.Uni<AmqpReceiver> createDynamicReceiver()
        Creates a dynamic receiver. The address is provided by the broker and is available in the completionHandler, using the AmqpReceiver.address() method. this method is useful for request-reply to generate a unique reply address.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • createDynamicReceiverAndAwait

        public AmqpReceiver createDynamicReceiverAndAwait()
        Blocking variant of createDynamicReceiver().

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Returns:
        the AmqpReceiver instance produced by the operation.

      • createDynamicReceiverAndForget

        public AmqpConnection createDynamicReceiverAndForget()
        Variant of createDynamicReceiver() that ignores the result of the operation.

        This method subscribes on the result of createDynamicReceiver(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from createDynamicReceiver() but you don't need to compose it with other operations.

        Returns:
        the instance of AmqpConnection to chain method calls.

      • createSender

        public io.smallrye.mutiny.Uni<AmqpSender> createSender​(String address)
        Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, check createAnonymousSender().

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        address - The target address to attach to, must not be null
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • createSenderAndAwait

        public AmqpSender createSenderAndAwait​(String address)
        Blocking variant of createSender(String).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        address - The target address to attach to, must not be null
        Returns:
        the AmqpSender instance produced by the operation.

      • createSenderAndForget

        public AmqpConnection createSenderAndForget​(String address)
        Variant of createSender(String) that ignores the result of the operation.

        This method subscribes on the result of createSender(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from createSender(String) but you don't need to compose it with other operations.

        Parameters:
        address - The target address to attach to, must not be null
        Returns:
        the instance of AmqpConnection to chain method calls.

      • createSender

        public io.smallrye.mutiny.Uni<AmqpSender> createSender​(String address,
                                                       io.vertx.amqp.AmqpSenderOptions options)
        Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, check createAnonymousSender().

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        address - The target address to attach to, allowed to be null if the options configures the sender to be attached to a dynamic address (provided by the broker).
        options - The AMQP sender options
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • createSenderAndAwait

        public AmqpSender createSenderAndAwait​(String address,
                                       io.vertx.amqp.AmqpSenderOptions options)
        Blocking variant of createSender(String,AmqpSenderOptions).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        address - The target address to attach to, allowed to be null if the options configures the sender to be attached to a dynamic address (provided by the broker).
        options - The AMQP sender options
        Returns:
        the AmqpSender instance produced by the operation.

      • createSenderAndForget

        public AmqpConnection createSenderAndForget​(String address,
                                            io.vertx.amqp.AmqpSenderOptions options)
        Variant of createSender(String,AmqpSenderOptions) that ignores the result of the operation.

        This method subscribes on the result of createSender(String,AmqpSenderOptions), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from createSender(String,AmqpSenderOptions) but you don't need to compose it with other operations.

        Parameters:
        address - The target address to attach to, allowed to be null if the options configures the sender to be attached to a dynamic address (provided by the broker).
        options - The AMQP sender options
        Returns:
        the instance of AmqpConnection to chain method calls.

      • createAnonymousSender

        public io.smallrye.mutiny.Uni<AmqpSender> createAnonymousSender()
        Creates an anonymous sender.

        Unlike "regular" sender, this sender is not associated to a specific address, and each message sent must provide an address. This method can be used in request-reply scenarios where you create a sender to send the reply, but you don't know the address, as the reply address is passed into the message you are going to receive.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • createAnonymousSenderAndAwait

        public AmqpSender createAnonymousSenderAndAwait()
        Blocking variant of createAnonymousSender().

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Returns:
        the AmqpSender instance produced by the operation.

      • createAnonymousSenderAndForget

        public AmqpConnection createAnonymousSenderAndForget()
        Variant of createAnonymousSender() that ignores the result of the operation.

        This method subscribes on the result of createAnonymousSender(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from createAnonymousSender() but you don't need to compose it with other operations.

        Returns:
        the instance of AmqpConnection to chain method calls.

      • isDisconnected

        public boolean isDisconnected()
        Returns:
        whether the connection has been disconnected.

      • closeFuture

        public io.smallrye.mutiny.Uni<Void> closeFuture()

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • closeFutureAndAwait

        public Void closeFutureAndAwait()
        Blocking variant of closeFuture().

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Returns:
        the Void instance produced by the operation.

      • closeFutureAndForget

        public void closeFutureAndForget()
        Variant of closeFuture() that ignores the result of the operation.

        This method subscribes on the result of closeFuture(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from closeFuture() but you don't need to compose it with other operations.

      • newInstance

        public static AmqpConnection newInstance​(io.vertx.amqp.AmqpConnection arg)