AmqpClient (Vertx Javadocs 4.0.3.GA API)

All Known Implementing Classes:

AmqpClientImpl
```
public interface AmqpClient
```
AMQP Client entry point. Use this interface to create an instance of AmqpClient and connect to a broker and server.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Future<Void>`	`close()` Like `close(Handler)` but returns a `Future` of the asynchronous result
`void`	`close(Handler<AsyncResult<Void>> closeHandler)` Closes the client.
`Future<AmqpConnection>`	`connect()` Like `connect(Handler)` but returns a `Future` of the asynchronous result
`AmqpClient`	`connect(Handler<AsyncResult<AmqpConnection>> connectionHandler)` Connects to the AMQP broker or router.
`static AmqpClient`	`create(AmqpClientOptions options)` Creates a new instance of `AmqpClient` using an internal Vert.x instance (with default configuration) and the given AMQP client configuration.
`static AmqpClient`	`create(Vertx vertx, AmqpClientOptions options)` Creates a new instance of `AmqpClient` with the given Vert.x instance and the given options.
`Future<AmqpReceiver>`	`createReceiver(String address)` Like `createReceiver(String, Handler)` but returns a `Future` of the asynchronous result
`Future<AmqpReceiver>`	`createReceiver(String address, AmqpReceiverOptions receiverOptions)` Like `createReceiver(String, AmqpReceiverOptions, Handler)` but returns a `Future` of the asynchronous result
`AmqpClient`	`createReceiver(String address, AmqpReceiverOptions receiverOptions, Handler<AsyncResult<AmqpReceiver>> completionHandler)` Creates a receiver used to consumer messages from the given address.
`AmqpClient`	`createReceiver(String address, Handler<AsyncResult<AmqpReceiver>> completionHandler)` Creates a receiver used to consume messages from the given address.
`Future<AmqpSender>`	`createSender(String address)` Like `createSender(String, Handler)` but returns a `Future` of the asynchronous result
`Future<AmqpSender>`	`createSender(String address, AmqpSenderOptions options)` Like `createSender(String, AmqpSenderOptions, Handler)` but returns a `Future` of the asynchronous result
`AmqpClient`	`createSender(String address, AmqpSenderOptions options, Handler<AsyncResult<AmqpSender>> completionHandler)` Creates a sender used to send messages to the given address.
`AmqpClient`	`createSender(String address, Handler<AsyncResult<AmqpSender>> completionHandler)` Creates a sender used to send messages to the given address.

- Method Detail
  - create
```
static AmqpClient create(AmqpClientOptions options)
```
    Creates a new instance of AmqpClient using an internal Vert.x instance (with default configuration) and the given AMQP client configuration. Note that the created Vert.x instance will be closed when the client is closed.
    
    Parameters:
    
    options - the AMQP client options, may be null falling back to the default configuration
    
    Returns:
    
    the created instances.
  - create
```
static AmqpClient create(Vertx vertx,
                         AmqpClientOptions options)
```
    Creates a new instance of AmqpClient with the given Vert.x instance and the given 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
```
AmqpClient connect(Handler<AsyncResult<AmqpConnection>> connectionHandler)
```
    Connects to the AMQP broker or router. The location is specified in the AmqpClientOptions as well as the potential credential required.
    
    Parameters:
    
    connectionHandler - handler that will process the result, giving either the connection or failure cause. Must not be null.
  - connect
```
Future<AmqpConnection> connect()
```
    Like connect(Handler) but returns a Future of the asynchronous result
  - close
```
void close(Handler<AsyncResult<Void>> closeHandler)
```
    Closes the client. The client must always be closed once not needed anymore.
    
    Parameters:
    
    closeHandler - the close handler notified when the operation completes. It can be null.
  - close
```
Future<Void> close()
```
    Like close(Handler) but returns a Future of the asynchronous result
  - createReceiver
```
AmqpClient createReceiver(String address,
                          Handler<AsyncResult<AmqpReceiver>> completionHandler)
```
    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().
    
    Parameters:
    
    address - The source address to attach the consumer to, must not be null
    
    completionHandler - the handler called with the receiver. The receiver has been opened.
    
    Returns:
    
    the client.
  - createReceiver
```
Future<AmqpReceiver> createReceiver(String address)
```
    Like createReceiver(String, Handler) but returns a Future of the asynchronous result
  - createReceiver
```
AmqpClient createReceiver(String address,
                          AmqpReceiverOptions receiverOptions,
                          Handler<AsyncResult<AmqpReceiver>> completionHandler)
```
    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().
    
    Parameters:
    
    address - The source address to attach the consumer to.
    
    receiverOptions - The options for this receiver.
    
    completionHandler - The handler called with the receiver, once opened. Note that the messageHandler can be called before the completionHandler if messages are awaiting delivery.
    
    Returns:
    
    the connection.
  - createReceiver
```
Future<AmqpReceiver> createReceiver(String address,
                                    AmqpReceiverOptions receiverOptions)
```
    Like createReceiver(String, AmqpReceiverOptions, Handler) but returns a Future of the asynchronous result
  - createSender
```
AmqpClient createSender(String address,
                        Handler<AsyncResult<AmqpSender>> completionHandler)
```
    Creates a sender used to send messages to the given address. The address must be set.
    
    Parameters:
    
    address - The target address to attach to, must not be null
    
    completionHandler - The handler called with the sender, once opened
    
    Returns:
    
    the client.
  - createSender
```
Future<AmqpSender> createSender(String address)
```
    Like createSender(String, Handler) but returns a Future of the asynchronous result
  - createSender
```
AmqpClient createSender(String address,
                        AmqpSenderOptions options,
                        Handler<AsyncResult<AmqpSender>> completionHandler)
```
    Creates a sender used to send messages to the given address. The address must be set.
    
    Parameters:
    
    address - The target address to attach to, must not be null
    
    options - The options for this sender.
    
    completionHandler - The handler called with the sender, once opened
    
    Returns:
    
    the client.
  - createSender
```
Future<AmqpSender> createSender(String address,
                                AmqpSenderOptions options)
```
    Like createSender(String, AmqpSenderOptions, Handler) but returns a Future of the asynchronous result

Interface AmqpClient

Method Summary

Method Detail

create

create

connect

connect

close

close

createReceiver

createReceiver

createReceiver

createReceiver

createSender

createSender

createSender

createSender