Package io.vertx.mutiny.amqp

Class AmqpClient

java.lang.Object
io.vertx.mutiny.amqp.AmqpClient
All Implemented Interfaces:
MutinyDelegate
public class AmqpClient extends Object implements MutinyDelegate
AMQP Client entry point. Use this interface to create an instance of AmqpClient and connect to a broker and server.

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

  • Field Details

  • Constructor Details

    • AmqpClient

      public AmqpClient(io.vertx.amqp.AmqpClient delegate)

    • AmqpClient

      public AmqpClient(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.amqp.AmqpClient getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • 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

    • create

      public static AmqpClient create(io.vertx.amqp.AmqpClientOptions options)
      Parameters:
      options - the AMQP client options, may be null falling back to the default configuration
      Returns:
      the created instances.

    • create

      public static AmqpClient create(Vertx vertx, io.vertx.amqp.AmqpClientOptions options)
      Parameters:
      vertx - the vert.x instance, must not be null
      options - the AMQP options, may be @{code null} falling back to the default configuration
      Returns:
      the AMQP client instance

    • connect

      @CheckReturnValue public io.smallrye.mutiny.Uni<AmqpConnection> connect()
      Connects to the AMQP broker or router. The location is specified in the AmqpClientOptions as well as the potential credential required.

      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.

    • connectAndAwait

      public AmqpConnection connectAndAwait()
      Blocking variant of connect().

      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 AmqpConnection instance produced by the operation.

    • connectAndForget

      public AmqpClient connectAndForget()
      Variant of connect() that ignores the result of the operation.

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

      Returns:
      the instance of AmqpClient to chain method calls.

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Closes the client. The client must always be closed once not needed anymore.

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

    • createReceiver

      @CheckReturnValue 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. This method avoids having to connect explicitly. You can retrieve the connection using AmqpReceiver.connection().

      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 AmqpClient 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 AmqpClient to chain method calls.

    • createReceiver

      @CheckReturnValue 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. This method avoids having to connect explicitly. You can retrieve the connection using AmqpReceiver.connection().

      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.

    • createReceiverAndForget

      public AmqpClient createReceiverAndForget(String address, io.vertx.amqp.AmqpReceiverOptions receiverOptions)
      Variant of createReceiver(String,AmqpReceiverOptions) that ignores the result of the operation.

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

      Parameters:
      address - The source address to attach the consumer to.
      receiverOptions - The options for this receiver.
      Returns:
      the instance of AmqpClient to chain method calls.

    • createSender

      @CheckReturnValue 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.

      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 AmqpClient 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 AmqpClient to chain method calls.

    • createSender

      @CheckReturnValue 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.

      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
      options - The options for this sender.
      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, must not be null
      options - The options for this sender.
      Returns:
      the AmqpSender instance produced by the operation.

    • createSenderAndForget

      public AmqpClient 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, must not be null
      options - The options for this sender.
      Returns:
      the instance of AmqpClient to chain method calls.

    • newInstance

      public static AmqpClient newInstance(io.vertx.amqp.AmqpClient arg)