Class AmqpConnection
- java.lang.Object
-
- io.vertx.rxjava3.amqp.AmqpConnection
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class AmqpConnection extends Object implements io.vertx.lang.rx.RxDelegate
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
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<AmqpConnection>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description AmqpConnection(AmqpConnection delegate)AmqpConnection(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Completableclose()Closes the AMQP connection, i.e. allows the Close frame to be emitted.CompletablecloseFuture()Single<AmqpSender>createAnonymousSender()Creates an anonymous sender.Single<AmqpReceiver>createDynamicReceiver()Creates a dynamic receiver.Single<AmqpReceiver>createReceiver(String address)Creates a receiver used to consume messages from the given address.Single<AmqpReceiver>createReceiver(String address, AmqpReceiverOptions receiverOptions)Creates a receiver used to consumer messages from the given address.Single<AmqpSender>createSender(String address)Creates a sender used to send messages to the given address.Single<AmqpSender>createSender(String address, AmqpSenderOptions options)Creates a sender used to send messages to the given address.booleanequals(Object o)AmqpConnectionexceptionHandler(Handler<Throwable> handler)Registers a handler called on disconnection.AmqpConnectiongetDelegate()inthashCode()booleanisDisconnected()static AmqpConnectionnewInstance(AmqpConnection arg)CompletablerxClose()Closes the AMQP connection, i.e. allows the Close frame to be emitted.CompletablerxCloseFuture()Single<AmqpSender>rxCreateAnonymousSender()Creates an anonymous sender.Single<AmqpReceiver>rxCreateDynamicReceiver()Creates a dynamic receiver.Single<AmqpReceiver>rxCreateReceiver(String address)Creates a receiver used to consume messages from the given address.Single<AmqpReceiver>rxCreateReceiver(String address, AmqpReceiverOptions receiverOptions)Creates a receiver used to consumer messages from the given address.Single<AmqpSender>rxCreateSender(String address)Creates a sender used to send messages to the given address.Single<AmqpSender>rxCreateSender(String address, AmqpSenderOptions options)Creates a sender used to send messages to the given address.StringtoString()io.vertx.proton.ProtonConnectionunwrap()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<AmqpConnection> __TYPE_ARG
-
-
Constructor Detail
-
AmqpConnection
public AmqpConnection(AmqpConnection delegate)
-
AmqpConnection
public AmqpConnection(Object delegate)
-
-
Method Detail
-
getDelegate
public AmqpConnection getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
exceptionHandler
public AmqpConnection exceptionHandler(Handler<Throwable> handler)
Registers a handler called on disconnection.- Parameters:
handler- the exception handler.- Returns:
- the connection
-
close
public Completable close()
Closes the AMQP connection, i.e. allows the Close frame to be emitted.- Returns:
- a future notified when the connection is closed
-
rxClose
public Completable rxClose()
Closes the AMQP connection, i.e. allows the Close frame to be emitted.- Returns:
- a future notified when the connection is closed
-
createReceiver
public Single<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.- Parameters:
address- The source address to attach the consumer to, must not benull- Returns:
- a future notified with the receiver. The receiver has been opened.
-
rxCreateReceiver
public Single<AmqpReceiver> rxCreateReceiver(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.- Parameters:
address- The source address to attach the consumer to, must not benull- Returns:
- a future notified with the receiver. The receiver has been opened.
-
createReceiver
public Single<AmqpReceiver> createReceiver(String address, AmqpReceiverOptions receiverOptions)
Creates a receiver used to consumer messages from the given address.- Parameters:
address- The source address to attach the consumer to.receiverOptions- The options for this receiver.- Returns:
- a future notified with the receiver, once opened. Note that the
messageHandlercan be called before thecompletionHandlerif messages are awaiting delivery.
-
rxCreateReceiver
public Single<AmqpReceiver> rxCreateReceiver(String address, AmqpReceiverOptions receiverOptions)
Creates a receiver used to consumer messages from the given address.- Parameters:
address- The source address to attach the consumer to.receiverOptions- The options for this receiver.- Returns:
- a future notified with the receiver, once opened. Note that the
messageHandlercan be called before thecompletionHandlerif messages are awaiting delivery.
-
createDynamicReceiver
public Single<AmqpReceiver> createDynamicReceiver()
Creates a dynamic receiver. The address is provided by the broker and is available in thecompletionHandler, using theAmqpReceiver.address()method. this method is useful for request-reply to generate a unique reply address.- Returns:
- a future notified when the receiver has been created and opened.
-
rxCreateDynamicReceiver
public Single<AmqpReceiver> rxCreateDynamicReceiver()
Creates a dynamic receiver. The address is provided by the broker and is available in thecompletionHandler, using theAmqpReceiver.address()method. this method is useful for request-reply to generate a unique reply address.- Returns:
- a future notified when the receiver has been created and opened.
-
createSender
public Single<AmqpSender> createSender(String address)
Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, checkcreateAnonymousSender().- Parameters:
address- The target address to attach to, must not benull- Returns:
- a future notified with the sender, once opened
-
rxCreateSender
public Single<AmqpSender> rxCreateSender(String address)
Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, checkcreateAnonymousSender().- Parameters:
address- The target address to attach to, must not benull- Returns:
- a future notified with the sender, once opened
-
createSender
public Single<AmqpSender> createSender(String address, AmqpSenderOptions options)
Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, checkcreateAnonymousSender().- Parameters:
address- The target address to attach to, allowed to benullif theoptionsconfigures the sender to be attached to a dynamic address (provided by the broker).options- The AMQP sender options- Returns:
- a future notified with the sender, once opened
-
rxCreateSender
public Single<AmqpSender> rxCreateSender(String address, AmqpSenderOptions options)
Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, checkcreateAnonymousSender().- Parameters:
address- The target address to attach to, allowed to benullif theoptionsconfigures the sender to be attached to a dynamic address (provided by the broker).options- The AMQP sender options- Returns:
- a future notified with the sender, once opened
-
createAnonymousSender
public Single<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.
- Returns:
- a future notifid with the created sender, once opened
-
rxCreateAnonymousSender
public Single<AmqpSender> rxCreateAnonymousSender()
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.
- Returns:
- a future notifid with the created sender, once opened
-
isDisconnected
public boolean isDisconnected()
- Returns:
- whether the connection has been disconnected.
-
closeFuture
public Completable closeFuture()
- Returns:
- a future completed when the connection is closed
-
rxCloseFuture
public Completable rxCloseFuture()
- Returns:
- a future completed when the connection is closed
-
unwrap
public io.vertx.proton.ProtonConnection unwrap()
- Returns:
- the underlying ProtonConnection.
-
newInstance
public static AmqpConnection newInstance(AmqpConnection arg)
-
-