AmqpConnectionImpl (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.amqp.impl.AmqpConnectionImpl

All Implemented Interfaces:: AmqpConnection

public class AmqpConnectionImpl
extends Object
implements AmqpConnection

Field Summary

Fields
Modifier and Type Field and Description

static String PRODUCT

static org.apache.qpid.proton.amqp.Symbol PRODUCT_KEY

Fields
Modifier and Type	Field and Description
`static String`	`PRODUCT`
`static org.apache.qpid.proton.amqp.Symbol`	`PRODUCT_KEY`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Future<Void>`	`close()` Like `AmqpConnection.close(Handler)` but returns a `Future` of the asynchronous result
`AmqpConnection`	`close(Handler<AsyncResult<Void>> done)` Closes the AMQP connection, i.e.
`Future<AmqpSender>`	`createAnonymousSender()` Like `AmqpConnection.createAnonymousSender(Handler)` but returns a `Future` of the asynchronous result
`AmqpConnection`	`createAnonymousSender(Handler<AsyncResult<AmqpSender>> completionHandler)` Creates an anonymous sender.
`Future<AmqpReceiver>`	`createDynamicReceiver()` Like `AmqpConnection.createDynamicReceiver(Handler)` but returns a `Future` of the asynchronous result
`AmqpConnection`	`createDynamicReceiver(Handler<AsyncResult<AmqpReceiver>> completionHandler)` Creates a dynamic receiver.
`Future<AmqpReceiver>`	`createReceiver(String address)` Like `AmqpConnection.createReceiver(String, Handler)` but returns a `Future` of the asynchronous result
`Future<AmqpReceiver>`	`createReceiver(String address, AmqpReceiverOptions receiverOptions)` Like `AmqpConnection.createReceiver(String, AmqpReceiverOptions, Handler)` but returns a `Future` of the asynchronous result
`AmqpConnection`	`createReceiver(String address, AmqpReceiverOptions receiverOptions, Handler<AsyncResult<AmqpReceiver>> completionHandler)` Creates a receiver used to consumer messages from the given address.
`AmqpConnection`	`createReceiver(String address, Handler<AsyncResult<AmqpReceiver>> completionHandler)` Creates a receiver used to consume messages from the given address.
`Future<AmqpSender>`	`createSender(String address)` Like `AmqpConnection.createSender(String, Handler)` but returns a `Future` of the asynchronous result
`Future<AmqpSender>`	`createSender(String address, AmqpSenderOptions options)` Like `AmqpConnection.createSender(String, AmqpSenderOptions, Handler)` but returns a `Future` of the asynchronous result
`AmqpConnection`	`createSender(String address, AmqpSenderOptions options, Handler<AsyncResult<AmqpSender>> completionHandler)` Creates a sender used to send messages to the given address.
`AmqpConnection`	`createSender(String address, Handler<AsyncResult<AmqpSender>> completionHandler)` Creates a sender used to send messages to the given address.
`AmqpConnection`	`exceptionHandler(Handler<Throwable> handler)` Registers a handler called on disconnection.
`boolean`	`isDisconnected()`
`AmqpClientOptions`	`options()`
`ProtonConnection`	`unwrap()` Allows retrieving the underlying `ProtonConnection`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRODUCT
```
public static final String PRODUCT
```
    See Also:
    
    Constant Field Values
  - PRODUCT_KEY
```
public static final org.apache.qpid.proton.amqp.Symbol PRODUCT_KEY
```
- Method Detail
  - exceptionHandler
```
public AmqpConnection exceptionHandler(Handler<Throwable> handler)
```
    Description copied from interface: AmqpConnection
    
    Registers a handler called on disconnection.
    
    Specified by:
    
    exceptionHandler in interface AmqpConnection
    
    Parameters:
    
    handler - the exception handler.
    
    Returns:
    
    the connection
  - close
```
public AmqpConnection close(Handler<AsyncResult<Void>> done)
```
    Description copied from interface: AmqpConnection
    
    Closes the AMQP connection, i.e. allows the Close frame to be emitted.
    
    Specified by:
    
    close in interface AmqpConnection
    
    Parameters:
    
    done - the close handler notified when the connection is closed. May be null.
    
    Returns:
    
    the connection
  - close
```
public Future<Void> close()
```
    Description copied from interface: AmqpConnection
    
    Like AmqpConnection.close(Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    close in interface AmqpConnection
  - createDynamicReceiver
```
public AmqpConnection createDynamicReceiver(Handler<AsyncResult<AmqpReceiver>> completionHandler)
```
    Description copied from interface: AmqpConnection
    
    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.
    
    Specified by:
    
    createDynamicReceiver in interface AmqpConnection
    
    Parameters:
    
    completionHandler - the completion handler, called when the receiver has been created and opened.
    
    Returns:
    
    the connection.
  - createDynamicReceiver
```
public Future<AmqpReceiver> createDynamicReceiver()
```
    Description copied from interface: AmqpConnection
    
    Like AmqpConnection.createDynamicReceiver(Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    createDynamicReceiver in interface AmqpConnection
  - createReceiver
```
public AmqpConnection createReceiver(String address,
                                     Handler<AsyncResult<AmqpReceiver>> completionHandler)
```
    Description copied from interface: AmqpConnection
    
    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.
    
    Specified by:
    
    createReceiver in interface AmqpConnection
    
    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 connection.
  - createReceiver
```
public Future<AmqpReceiver> createReceiver(String address)
```
    Description copied from interface: AmqpConnection
    
    Like AmqpConnection.createReceiver(String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    createReceiver in interface AmqpConnection
  - createReceiver
```
public AmqpConnection createReceiver(String address,
                                     AmqpReceiverOptions receiverOptions,
                                     Handler<AsyncResult<AmqpReceiver>> completionHandler)
```
    Description copied from interface: AmqpConnection
    
    Creates a receiver used to consumer messages from the given address.
    
    Specified by:
    
    createReceiver in interface AmqpConnection
    
    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
```
public Future<AmqpReceiver> createReceiver(String address,
                                           AmqpReceiverOptions receiverOptions)
```
    Description copied from interface: AmqpConnection
    
    Like AmqpConnection.createReceiver(String, AmqpReceiverOptions, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    createReceiver in interface AmqpConnection
  - createSender
```
public AmqpConnection createSender(String address,
                                   Handler<AsyncResult<AmqpSender>> completionHandler)
```
    Description copied from interface: AmqpConnection
    
    Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, check AmqpConnection.createAnonymousSender(Handler).
    
    Specified by:
    
    createSender in interface AmqpConnection
    
    Parameters:
    
    address - The target address to attach to, must not be null
    
    completionHandler - The handler called with the sender, once opened
    
    Returns:
    
    the connection.
    
    See Also:
    
    AmqpConnection.createAnonymousSender(Handler)
  - createSender
```
public Future<AmqpSender> createSender(String address)
```
    Description copied from interface: AmqpConnection
    
    Like AmqpConnection.createSender(String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    createSender in interface AmqpConnection
  - createSender
```
public AmqpConnection createSender(String address,
                                   AmqpSenderOptions options,
                                   Handler<AsyncResult<AmqpSender>> completionHandler)
```
    Description copied from interface: AmqpConnection
    
    Creates a sender used to send messages to the given address. The address must be set. For anonymous sender, check AmqpConnection.createAnonymousSender(Handler).
    
    Specified by:
    
    createSender in interface AmqpConnection
    
    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
    
    completionHandler - The handler called with the sender, once opened
    
    Returns:
    
    the connection.
    
    See Also:
    
    AmqpConnection.createAnonymousSender(Handler)
  - createSender
```
public Future<AmqpSender> createSender(String address,
                                       AmqpSenderOptions options)
```
    Description copied from interface: AmqpConnection
    
    Like AmqpConnection.createSender(String, AmqpSenderOptions, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    createSender in interface AmqpConnection
  - createAnonymousSender
```
public AmqpConnection createAnonymousSender(Handler<AsyncResult<AmqpSender>> completionHandler)
```
    Description copied from interface: AmqpConnection
    
    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.
    
    Specified by:
    
    createAnonymousSender in interface AmqpConnection
    
    Parameters:
    
    completionHandler - The handler called with the created sender, once opened
    
    Returns:
    
    the connection.
  - createAnonymousSender
```
public Future<AmqpSender> createAnonymousSender()
```
    Description copied from interface: AmqpConnection
    
    Like AmqpConnection.createAnonymousSender(Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    createAnonymousSender in interface AmqpConnection
  - isDisconnected
```
public boolean isDisconnected()
```
    Specified by:
    
    isDisconnected in interface AmqpConnection
    
    Returns:
    
    whether the connection has been disconnected.
  - unwrap
```
public ProtonConnection unwrap()
```
    Allows retrieving the underlying ProtonConnection.
    
    Returns:
    
    the underlying connection
  - options
```
public AmqpClientOptions options()
```

Class AmqpConnectionImpl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRODUCT

PRODUCT_KEY

Method Detail

exceptionHandler

close

close

createDynamicReceiver

createDynamicReceiver

createReceiver

createReceiver

createReceiver

createReceiver

createSender

createSender

createSender

createSender

createAnonymousSender

createAnonymousSender

isDisconnected

unwrap

options