com.rabbitmq.client.impl

Class AMQConnection

java.lang.Object

com.rabbitmq.client.impl.ShutdownNotifierComponent

com.rabbitmq.client.impl.AMQConnection

All Implemented Interfaces:

Connection, NetworkConnection, ShutdownNotifier, Closeable, AutoCloseable

Direct Known Subclasses:

RecoveryAwareAMQConnection

public class AMQConnection
extends ShutdownNotifierComponent
implements Connection, NetworkConnection

Concrete class representing and managing an AMQP connection to a broker.

To create a broker connection, use ConnectionFactory. See Connection for an example.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConsumerWorkService	_workService
static double	CHANNEL_SHUTDOWN_TIMEOUT_MULTIPLIER
protected MetricsCollector	metricsCollector

Constructor Summary

Constructors

Constructor and Description
AMQConnection(ConnectionParams params, FrameHandler frameHandler)
AMQConnection(ConnectionParams params, FrameHandler frameHandler, MetricsCollector metricsCollector) Construct a new connection

Method Summary

Modifier and Type	Method and Description
void	abort() Public API - Abort this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'.
void	abort(int timeout) Public API - Abort this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'.
void	abort(int closeCode, String closeMessage) Public API - Abort this connection and all its channels.
void	abort(int closeCode, String closeMessage, int timeout) Public API - Abort this connection and all its channels.
BlockedListener	addBlockedListener(BlockedCallback blockedCallback, UnblockedCallback unblockedCallback) Add a lambda-based BlockedListener.
void	addBlockedListener(BlockedListener listener) Add a BlockedListener.
void	addRecoveryCanBeginListener(RecoveryCanBeginListener fn)
void	clearBlockedListeners() Remove all BlockedListeners.
void	close() Public API - Close this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'.
void	close(int timeout) Public API - Close this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'.
void	close(int closeCode, String closeMessage) Public API - Close this connection and all its channels.
void	close(int closeCode, String closeMessage, boolean initiatedByApplication, Throwable cause) Protected API - Delegates to the six-argument close method, passing -1 for the timeout, and false for the abort flag.
void	close(int closeCode, String closeMessage, boolean initiatedByApplication, Throwable cause, int timeout, boolean abort) Protected API - Close this connection with the given code, message, source and timeout value for all the close operations to complete.
void	close(int closeCode, String closeMessage, int timeout) Public API - Close this connection and all its channels.
protected void	configureChannelManager(ChannelManager channelManager)
Channel	createChannel() Public API - Create a new channel, using an internally allocated channel number.
Channel	createChannel(int channelNumber) Public API - Create a new channel, using the specified channel number if possible.
static Map<String,Object>	defaultClientProperties() Retrieve a copy of the default table of client properties that will be sent to the server during connection startup.
void	disconnectChannel(ChannelN channel) Protected API - respond, in the driver thread, to a ShutdownSignal.
void	doFinalShutdown() private API
void	flush() Public API - flush the output buffers
InetAddress	getAddress() Retrieve the host.
int	getChannelMax() Get the negotiated maximum channel number.
int	getChannelRpcTimeout()
Map<String,Object>	getClientProperties() Get a copy of the map of client properties sent to the server
String	getClientProvidedName() Returns client-provided connection name, if any.
ExceptionHandler	getExceptionHandler() Protected API - retrieve the current ExceptionHandler
FrameHandler	getFrameHandler()
int	getFrameMax() Get the negotiated maximum frame size.
int	getHeartbeat() Get the negotiated heartbeat interval.
String	getId() Public API - Returns a unique ID for this connection.
InetAddress	getLocalAddress() Retrieve the local host.
int	getLocalPort() Retrieve the local port number.
int	getPort() Retrieve the port number.
Map<String,Object>	getServerProperties() Retrieve the server properties.
ThreadFactory	getThreadFactory()
TrafficListener	getTrafficListener()
void	handleConnectionClose(Command closeCommand)
void	handleHeartbeatFailure() private API
void	handleIoError(Throwable ex) private API
boolean	handleReadFrame(Frame frame) private API
boolean	hasBrokerInitiatedShutdown()
protected ChannelManager	instantiateChannelManager(int channelMax, ThreadFactory threadFactory)
boolean	isRunning()
protected int	negotiateChannelMax(int requestedChannelMax, int serverMax) Private API, allows for easier simulation of bogus clients.
boolean	processControlCommand(Command c) Handles incoming control commands on channel zero.
boolean	removeBlockedListener(BlockedListener listener) Remove a BlockedListener.
void	removeRecoveryCanBeginListener(RecoveryCanBeginListener fn)
void	setHeartbeat(int heartbeat) Protected API - set the heartbeat timeout.
void	setId(String id) Public API - Sets a unique ID for this connection.
void	setThreadFactory(ThreadFactory threadFactory) Makes it possible to override thread factory that is used to instantiate connection network I/O loop.
ShutdownSignalException	shutdown(Method reason, boolean initiatedByApplication, Throwable cause, boolean notifyRpc) Protected API - causes all attached channels to terminate (shutdown) with a ShutdownSignal built from the argument, and stops this connection from accepting further work from the application.
void	start() Start up the connection, including the MainLoop thread.
void	startMainLoop() Package private API, allows for easier testing.
String	toString()
boolean	willCheckRpcResponseType()
boolean	willShutDownConsumerExecutor() Public API
void	writeFrame(Frame f) Public API - sends a frame directly to the broker.

Methods inherited from class com.rabbitmq.client.impl.ShutdownNotifierComponent

addShutdownListener, getCloseReason, isOpen, notifyListeners, removeShutdownListener, setShutdownCauseIfOpen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.rabbitmq.client.Connection

openChannel, openChannel

Methods inherited from interface com.rabbitmq.client.ShutdownNotifier

addShutdownListener, getCloseReason, isOpen, notifyListeners, removeShutdownListener

Field Detail

CHANNEL_SHUTDOWN_TIMEOUT_MULTIPLIER

public static final double CHANNEL_SHUTDOWN_TIMEOUT_MULTIPLIER

See Also:

Constant Field Values

_workService

protected ConsumerWorkService _workService

metricsCollector

protected final MetricsCollector metricsCollector

Constructor Detail

AMQConnection

public AMQConnection(ConnectionParams params,
                     FrameHandler frameHandler)

AMQConnection

public AMQConnection(ConnectionParams params,
                     FrameHandler frameHandler,
                     MetricsCollector metricsCollector)

Construct a new connection

Parameters:

params - parameters for it

Method Detail

defaultClientProperties

public static Map<String,Object> defaultClientProperties()

Retrieve a copy of the default table of client properties that will be sent to the server during connection startup. This method is called when each new ConnectionFactory instance is constructed.

Returns:

a map of client properties

See Also:

Connection.getClientProperties()

disconnectChannel

public final void disconnectChannel(ChannelN channel)

Protected API - respond, in the driver thread, to a ShutdownSignal.

Parameters:

channel - the channel to disconnect

getAddress

public InetAddress getAddress()

Retrieve the host.

Specified by:

getAddress in interface Connection

Specified by:

getAddress in interface NetworkConnection

Returns:

the hostname of the peer we're connected to.

getLocalAddress

public InetAddress getLocalAddress()

Description copied from interface: NetworkConnection

Retrieve the local host.

Specified by:

getLocalAddress in interface NetworkConnection

Returns:

the client socket address.

getPort

public int getPort()

Retrieve the port number.

Specified by:

getPort in interface Connection

Specified by:

getPort in interface NetworkConnection

Returns:

the port number of the peer we're connected to.

getLocalPort

public int getLocalPort()

Description copied from interface: NetworkConnection

Retrieve the local port number.

Specified by:

getLocalPort in interface NetworkConnection

Returns:

the client socket port number

getFrameHandler

public FrameHandler getFrameHandler()

getServerProperties

public Map<String,Object> getServerProperties()

Retrieve the server properties.

Specified by:

getServerProperties in interface Connection

Returns:

a map of the server properties. This typically includes the product name and version of the server.

start

public void start()
           throws IOException,
                  TimeoutException

Start up the connection, including the MainLoop thread. Sends the protocol version negotiation header, and runs through Connection.Start/.StartOk, Connection.Tune/.TuneOk, and then calls Connection.Open and waits for the OpenOk. Sets heart-beat and frame max values after tuning has taken place.

Throws:

IOException - if an error is encountered either before, or during, protocol negotiation; sub-classes ProtocolVersionMismatchException and PossibleAuthenticationFailureException will be thrown in the corresponding circumstances. AuthenticationFailureException will be thrown if the broker closes the connection with ACCESS_REFUSED. If an exception is thrown, connection resources allocated can all be garbage collected when the connection object is no longer referenced.

TimeoutException

instantiateChannelManager

protected ChannelManager instantiateChannelManager(int channelMax,
                                                   ThreadFactory threadFactory)

configureChannelManager

protected void configureChannelManager(ChannelManager channelManager)

startMainLoop

public void startMainLoop()

Package private API, allows for easier testing.

negotiateChannelMax

protected int negotiateChannelMax(int requestedChannelMax,
                                  int serverMax)

Private API, allows for easier simulation of bogus clients.

getChannelMax

public int getChannelMax()

Get the negotiated maximum channel number. Usable channel numbers range from 1 to this number, inclusive.

Specified by:

getChannelMax in interface Connection

Returns:

the maximum channel number permitted for this connection.

getFrameMax

public int getFrameMax()

Get the negotiated maximum frame size.

Specified by:

getFrameMax in interface Connection

Returns:

the maximum frame size, in octets; zero if unlimited

getHeartbeat

public int getHeartbeat()

Get the negotiated heartbeat interval.

Specified by:

getHeartbeat in interface Connection

Returns:

the heartbeat interval, in seconds; zero if none

setHeartbeat

public void setHeartbeat(int heartbeat)

Protected API - set the heartbeat timeout. Should only be called during tuning.

setThreadFactory

public void setThreadFactory(ThreadFactory threadFactory)

Makes it possible to override thread factory that is used to instantiate connection network I/O loop. Only necessary in the environments with restricted

Parameters:

threadFactory - thread factory to use

getThreadFactory

public ThreadFactory getThreadFactory()

Returns:

Thread factory used by this connection.

getClientProperties

public Map<String,Object> getClientProperties()

Description copied from interface: Connection

Get a copy of the map of client properties sent to the server

Specified by:

getClientProperties in interface Connection

Returns:

a copy of the map of client properties

getClientProvidedName

public String getClientProvidedName()

Description copied from interface: Connection

Returns client-provided connection name, if any. Note that the value returned does not uniquely identify a connection and cannot be used as a connection identifier in HTTP API requests.

Specified by:

getClientProvidedName in interface Connection

Returns:

client-provided connection name, if any

See Also:

ConnectionFactory.newConnection(Address[], String), ConnectionFactory.newConnection(ExecutorService, Address[], String)

getExceptionHandler

public ExceptionHandler getExceptionHandler()

Protected API - retrieve the current ExceptionHandler

Specified by:

getExceptionHandler in interface Connection

See Also:

ExceptionHandler

willShutDownConsumerExecutor

public boolean willShutDownConsumerExecutor()

Public API

Returns:

true if this work service instance uses its own consumerWorkServiceExecutor (as opposed to a shared one)

createChannel

public Channel createChannel(int channelNumber)
                      throws IOException

Public API - Create a new channel, using the specified channel number if possible.

Use Connection.openChannel(int) if you want to use an Optional to deal with a value.

Specified by:

createChannel in interface Connection

Parameters:

channelNumber - the channel number to allocate

Returns:

a new channel descriptor, or null if this channel number is already in use

Throws:

IOException - if an I/O problem is encountered

createChannel

public Channel createChannel()
                      throws IOException

Public API - Create a new channel, using an internally allocated channel number. If automatic connection recovery is enabled, the channel returned by this method will be Recoverable.

Use Connection.openChannel() if you want to use an Optional to deal with a value.

Specified by:

createChannel in interface Connection

Returns:

a new channel descriptor, or null if none is available

Throws:

IOException - if an I/O problem is encountered

writeFrame

public void writeFrame(Frame f)
                throws IOException

Public API - sends a frame directly to the broker.

Throws:

IOException

flush

public void flush()
           throws IOException

Public API - flush the output buffers

Throws:

IOException

handleReadFrame

public boolean handleReadFrame(Frame frame)

private API

isRunning

public boolean isRunning()

hasBrokerInitiatedShutdown

public boolean hasBrokerInitiatedShutdown()

handleHeartbeatFailure

public void handleHeartbeatFailure()

private API

handleIoError

public void handleIoError(Throwable ex)

private API

doFinalShutdown

public void doFinalShutdown()

private API

addRecoveryCanBeginListener

public void addRecoveryCanBeginListener(RecoveryCanBeginListener fn)

removeRecoveryCanBeginListener

public void removeRecoveryCanBeginListener(RecoveryCanBeginListener fn)

processControlCommand

public boolean processControlCommand(Command c)
                              throws IOException

Handles incoming control commands on channel zero.

Throws:

IOException

See Also:

ChannelN.processAsync(com.rabbitmq.client.Command)

handleConnectionClose

public void handleConnectionClose(Command closeCommand)

shutdown

public ShutdownSignalException shutdown(Method reason,
                                        boolean initiatedByApplication,
                                        Throwable cause,
                                        boolean notifyRpc)

Protected API - causes all attached channels to terminate (shutdown) with a ShutdownSignal built from the argument, and stops this connection from accepting further work from the application. ShutdownListeners for the connection are notified when the main loop terminates.

Parameters:

reason - description of reason for the exception

initiatedByApplication - true if caused by a client command

cause - trigger exception which caused shutdown

notifyRpc - true if outstanding rpc should be informed of shutdown

Returns:

a shutdown signal built using the given arguments

close

public void close()
           throws IOException

Public API - Close this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'. Waits for all the close operations to complete.

Specified by:

close in interface Connection

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O problem is encountered

close

public void close(int timeout)
           throws IOException

Public API - Close this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'. This method behaves in a similar way as Connection.close(), with the only difference that it waits with a provided timeout for all the close operations to complete. When timeout is reached the socket is forced to close.

Specified by:

close in interface Connection

Parameters:

timeout - timeout (in milliseconds) for completing all the close-related operations, use -1 for infinity

Throws:

IOException - if an I/O problem is encountered

close

public void close(int closeCode,
                  String closeMessage)
           throws IOException

Public API - Close this connection and all its channels. Waits for all the close operations to complete.

Specified by:

close in interface Connection

Parameters:

closeCode - the close code (See under "Reply Codes" in the AMQP specification)

closeMessage - a message indicating the reason for closing the connection

Throws:

IOException - if an I/O problem is encountered

close

public void close(int closeCode,
                  String closeMessage,
                  int timeout)
           throws IOException

Public API - Close this connection and all its channels. Waits with the given timeout for all the close operations to complete. When timeout is reached the socket is forced to close.

Specified by:

close in interface Connection

Parameters:

closeCode - the close code (See under "Reply Codes" in the AMQP specification)

closeMessage - a message indicating the reason for closing the connection

timeout - timeout (in milliseconds) for completing all the close-related operations, use -1 for infinity

Throws:

IOException - if an I/O problem is encountered

abort

public void abort()

Public API - Abort this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'. Forces the connection to close. Any encountered exceptions in the close operations are silently discarded.

Specified by:

abort in interface Connection

abort

public void abort(int closeCode,
                  String closeMessage)

Public API - Abort this connection and all its channels. Forces the connection to close and waits for all the close operations to complete. Any encountered exceptions in the close operations are silently discarded.

Specified by:

abort in interface Connection

Parameters:

closeCode - the close code (See under "Reply Codes" in the AMQP specification)

closeMessage - a message indicating the reason for closing the connection

abort

public void abort(int timeout)

Public API - Abort this connection and all its channels with the AMQP.REPLY_SUCCESS close code and message 'OK'. This method behaves in a similar way as Connection.abort(), with the only difference that it waits with a provided timeout for all the close operations to complete. When timeout is reached the socket is forced to close.

Specified by:

abort in interface Connection

Parameters:

timeout - timeout (in milliseconds) for completing all the close-related operations, use -1 for infinity

abort

public void abort(int closeCode,
                  String closeMessage,
                  int timeout)

Public API - Abort this connection and all its channels. Forces the connection to close and waits with the given timeout for all the close operations to complete. When timeout is reached the socket is forced to close. Any encountered exceptions in the close operations are silently discarded.

Specified by:

abort in interface Connection

Parameters:

closeCode - the close code (See under "Reply Codes" in the AMQP specification)

closeMessage - a message indicating the reason for closing the connection

timeout - timeout (in milliseconds) for completing all the close-related operations, use -1 for infinity

close

public void close(int closeCode,
                  String closeMessage,
                  boolean initiatedByApplication,
                  Throwable cause)
           throws IOException

Protected API - Delegates to the six-argument close method, passing -1 for the timeout, and false for the abort flag.

Throws:

IOException

close

public void close(int closeCode,
                  String closeMessage,
                  boolean initiatedByApplication,
                  Throwable cause,
                  int timeout,
                  boolean abort)
           throws IOException

Protected API - Close this connection with the given code, message, source and timeout value for all the close operations to complete. Specifies if any encountered exceptions should be ignored.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

addBlockedListener

public void addBlockedListener(BlockedListener listener)

Description copied from interface: Connection

Add a BlockedListener.

Specified by:

addBlockedListener in interface Connection

Parameters:

listener - the listener to add

addBlockedListener

public BlockedListener addBlockedListener(BlockedCallback blockedCallback,
                                          UnblockedCallback unblockedCallback)

Description copied from interface: Connection

Add a lambda-based BlockedListener.

Specified by:

addBlockedListener in interface Connection

Parameters:

blockedCallback - the callback when the connection is blocked

unblockedCallback - the callback when the connection is unblocked

Returns:

the listener that wraps the callback

See Also:

BlockedListener, BlockedCallback, UnblockedCallback

removeBlockedListener

public boolean removeBlockedListener(BlockedListener listener)

Description copied from interface: Connection

Remove a BlockedListener.

Specified by:

removeBlockedListener in interface Connection

Parameters:

listener - the listener to remove

Returns:

true if the listener was found and removed, false otherwise

clearBlockedListeners

public void clearBlockedListeners()

Description copied from interface: Connection

Remove all BlockedListeners.

Specified by:

clearBlockedListeners in interface Connection

getId

public String getId()

Public API - Returns a unique ID for this connection. This ID must be unique, otherwise some services like the metrics collector won't work properly. This ID doesn't have to be provided by the client, services that require it will be assigned automatically if not set.

Specified by:

getId in interface Connection

Returns:

unique ID for this connection.

setId

public void setId(String id)

Public API - Sets a unique ID for this connection. This ID must be unique, otherwise some services like the metrics collector won't work properly. This ID doesn't have to be provided by the client, services that require it will be assigned automatically if not set.

Specified by:

setId in interface Connection

getChannelRpcTimeout

public int getChannelRpcTimeout()

willCheckRpcResponseType

public boolean willCheckRpcResponseType()

getTrafficListener

public TrafficListener getTrafficListener()