Package com.rabbitmq.client.impl
Class ChannelN
- java.lang.Object
-
- com.rabbitmq.client.impl.ShutdownNotifierComponent
-
- com.rabbitmq.client.impl.AMQChannel
-
- com.rabbitmq.client.impl.ChannelN
-
- All Implemented Interfaces:
Channel,ShutdownNotifier
- Direct Known Subclasses:
RecoveryAwareChannelN
public class ChannelN extends AMQChannel implements Channel
Main interface to AMQP protocol functionality. Public API - Implementation of all AMQChannels except channel zero.To open a channel,
Connectionconn = ...;ChannelNch1 = conn.createChannel();
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.rabbitmq.client.impl.AMQChannel
AMQChannel.BlockingRpcContinuation<T>, AMQChannel.RpcContinuation, AMQChannel.SimpleBlockingRpcContinuation
-
-
Field Summary
Fields Modifier and Type Field Description protected MetricsCollectormetricsCollector-
Fields inherited from class com.rabbitmq.client.impl.AMQChannel
_blockContent, _channelMutex, _rpcTimeout, NO_RPC_TIMEOUT
-
-
Constructor Summary
Constructors Constructor Description ChannelN(AMQConnection connection, int channelNumber, ConsumerWorkService workService)Construct a new channel on the given connection with the given channel number.ChannelN(AMQConnection connection, int channelNumber, ConsumerWorkService workService, MetricsCollector metricsCollector)Construct a new channel on the given connection with the given channel number.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidabort()Public API - Abort this channel with theAMQP.REPLY_SUCCESSclose code and message 'OK'.voidabort(int closeCode, String closeMessage)Public API - Abort this channel.voidaddConfirmListener(ConfirmListener listener)Add aConfirmListener.voidaddFlowListener(FlowListener listener)Deprecated.voidaddReturnListener(ReturnListener listener)Add aReturnListener.voidasyncRpc(Method method)Asynchronously send a method over this channel.voidbasicAck(long deliveryTag, boolean multiple)Public API - Acknowledge one or several received messages.voidbasicCancel(String consumerTag)Public API - Cancel a consumer.StringbasicConsume(String queue, boolean autoAck, Consumer callback)Public API - Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag.StringbasicConsume(String queue, boolean autoAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String,Object> arguments, Consumer callback)Public API - Start a consumer.StringbasicConsume(String queue, boolean autoAck, String consumerTag, Consumer callback)Public API - Start a non-nolocal, non-exclusive consumer.StringbasicConsume(String queue, boolean autoAck, Map<String,Object> arguments, Consumer callback)Public API - Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag and specified arguments.StringbasicConsume(String queue, Consumer callback)Public API - Start a non-nolocal, non-exclusive consumer, with explicit acknowledgement and a server-generated consumerTag.GetResponsebasicGet(String queue, boolean autoAck)Public API - Retrieve a message from a queue usingAMQP.Basic.GetvoidbasicNack(long deliveryTag, boolean multiple, boolean requeue)Public API - Reject one or several received messages.voidbasicPublish(String exchange, String routingKey, boolean mandatory, boolean immediate, AMQP.BasicProperties props, byte[] body)Public API - Publish a message.voidbasicPublish(String exchange, String routingKey, boolean mandatory, AMQP.BasicProperties props, byte[] body)Public API - Publish a message.voidbasicPublish(String exchange, String routingKey, AMQP.BasicProperties props, byte[] body)Public API - Publish a message.voidbasicQos(int prefetchCount)Public API - Request a specific prefetchCount "quality of service" settings for this channel.voidbasicQos(int prefetchCount, boolean global)Public API - Request a specific prefetchCount "quality of service" settings for this channel.voidbasicQos(int prefetchSize, int prefetchCount, boolean global)Public API - Request specific "quality of service" settings.AMQImpl.Basic.RecoverOkbasicRecover()Public API - Ask the broker to resend unacknowledged messages.AMQImpl.Basic.RecoverOkbasicRecover(boolean requeue)Public API - Ask the broker to resend unacknowledged messages.voidbasicReject(long deliveryTag, boolean requeue)Public API - Reject a message.voidclearConfirmListeners()Remove allConfirmListeners.voidclearFlowListeners()Deprecated.voidclearReturnListeners()Remove allReturnListeners.voidclose()Public API - Close this channel with theAMQP.REPLY_SUCCESSclose code and message 'OK'.voidclose(int closeCode, String closeMessage)Public API - Close this channel.protected voidclose(int closeCode, String closeMessage, boolean initiatedByApplication, Throwable cause, boolean abort)Protected API - Close channel with code and message, indicating the source of the closure and a causing exception (null if none).AMQImpl.Confirm.SelectOkconfirmSelect()Public API - Enables publisher acknowledgements on this channel.longconsumerCount(String queue)Public API - Returns the number of consumers on a queue.voidenqueueRpc(AMQChannel.RpcContinuation k)AMQImpl.Exchange.BindOkexchangeBind(String destination, String source, String routingKey)Public API - Bind an exchange to an exchange, with no extra arguments.AMQImpl.Exchange.BindOkexchangeBind(String destination, String source, String routingKey, Map<String,Object> arguments)Public API - Bind an exchange to an exchange.voidexchangeBindNoWait(String destination, String source, String routingKey, Map<String,Object> arguments)Public API - LikeChannel.exchangeBind(String, String, String, java.util.Map)but sets nowait parameter to true and returns void (as there will be no response from the server).AMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, BuiltinExchangeType type)Public API - Actively declare a non-autodelete, non-durable exchange with no extra argumentsAMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable)Public API - Actively declare a non-autodelete exchange with no extra argumentsAMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments)Public API - Declare an exchange, via an interface that allows the complete set of arguments.AMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, Map<String,Object> arguments)Public API - Declare an exchange.AMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, String type)Public API - Actively declare a non-autodelete, non-durable exchange with no extra argumentsAMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, String type, boolean durable)Public API - Actively declare a non-autodelete exchange with no extra argumentsAMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, String type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments)Public API - Declare an exchange, via an interface that allows the complete set of arguments.AMQImpl.Exchange.DeclareOkexchangeDeclare(String exchange, String type, boolean durable, boolean autoDelete, Map<String,Object> arguments)Public API - Declare an exchange.voidexchangeDeclareNoWait(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments)LikeChannel.exchangeDeclare(String, String, boolean, boolean, java.util.Map)but sets nowait parameter to true and returns nothing (as there will be no response from the server).voidexchangeDeclareNoWait(String exchange, String type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments)LikeChannel.exchangeDeclare(String, String, boolean, boolean, java.util.Map)but sets nowait parameter to true and returns nothing (as there will be no response from the server).AMQImpl.Exchange.DeclareOkexchangeDeclarePassive(String exchange)Public API - Declare an exchange passively; that is, check if the named exchange exists.AMQImpl.Exchange.DeleteOkexchangeDelete(String exchange)Public API - Delete an exchange, without regard for whether it is in use or notAMQImpl.Exchange.DeleteOkexchangeDelete(String exchange, boolean ifUnused)Public API - Delete an exchangevoidexchangeDeleteNoWait(String exchange, boolean ifUnused)Public API - LikeChannel.exchangeDelete(String, boolean)but sets nowait parameter to true and returns void (as there will be no response from the server).AMQImpl.Exchange.UnbindOkexchangeUnbind(String destination, String source, String routingKey)Public API - Unbind an exchange from an exchange, with no extra arguments.AMQImpl.Exchange.UnbindOkexchangeUnbind(String destination, String source, String routingKey, Map<String,Object> arguments)Public API - Unbind an exchange from an exchange.voidexchangeUnbindNoWait(String destination, String source, String routingKey, Map<String,Object> arguments)Public API - Same asChannel.exchangeUnbind(String, String, String, java.util.Map)but sets no-wait parameter to true and returns nothing (as there will be no response from the server).booleanflowBlocked()Deprecated.ConsumergetDefaultConsumer()Returns the current default consumer.longgetNextPublishSeqNo()Public API - When in confirm mode, returns the sequence number of the next message to be published.protected voidmarkRpcFinished()longmessageCount(String queue)Public API - Returns the number of messages in a queue ready to be delivered to consumers.voidopen()Package method: open the channel.booleanprocessAsync(Command command)Protected API - Filters the inbound command stream, processing Basic.Deliver, Basic.Return and Channel.Close specially.protected voidprocessDelivery(Command command, AMQImpl.Basic.Deliver method)voidprocessShutdownSignal(ShutdownSignalException signal, boolean ignoreClosed, boolean notifyRpc)Protected API - overridden to quiesce consumer work and broadcast the signal to all consumers after calling the superclass's method.AMQImpl.Queue.BindOkqueueBind(String queue, String exchange, String routingKey)Public API - Bind a queue to an exchange, with no extra arguments.AMQImpl.Queue.BindOkqueueBind(String queue, String exchange, String routingKey, Map<String,Object> arguments)Public API - Bind a queue to an exchange.voidqueueBindNoWait(String queue, String exchange, String routingKey, Map<String,Object> arguments)Public API - Same asChannel.queueBind(String, String, String, java.util.Map)but sets nowait parameter to true and returns void (as there will be no response from the server).AMQP.Queue.DeclareOkqueueDeclare()Public API - Actively declare a server-named exclusive, autodelete, non-durable queue.AMQImpl.Queue.DeclareOkqueueDeclare(String queue, boolean durable, boolean exclusive, boolean autoDelete, Map<String,Object> arguments)Public API - Declare a queuevoidqueueDeclareNoWait(String queue, boolean durable, boolean exclusive, boolean autoDelete, Map<String,Object> arguments)Public API - LikeChannel.queueDeclare(String, boolean, boolean, boolean, java.util.Map)but sets nowait flag to true and returns no result (as there will be no response from the server).AMQImpl.Queue.DeclareOkqueueDeclarePassive(String queue)Public API - Declare a queue passively; i.e., check if it exists.AMQImpl.Queue.DeleteOkqueueDelete(String queue)Public API - Delete a queue, without regard for whether it is in use or has messages on itAMQImpl.Queue.DeleteOkqueueDelete(String queue, boolean ifUnused, boolean ifEmpty)Public API - Delete a queuevoidqueueDeleteNoWait(String queue, boolean ifUnused, boolean ifEmpty)LikeChannel.queueDelete(String, boolean, boolean)but sets nowait parameter to true and returns nothing (as there will be no response from the server).AMQImpl.Queue.PurgeOkqueuePurge(String queue)Public API - Purges the contents of the given queue.AMQImpl.Queue.UnbindOkqueueUnbind(String queue, String exchange, String routingKey)Public API - Unbinds a queue from an exchange, with no extra arguments.AMQImpl.Queue.UnbindOkqueueUnbind(String queue, String exchange, String routingKey, Map<String,Object> arguments)Public API - Unbind a queue from an exchange.booleanremoveConfirmListener(ConfirmListener listener)Remove aConfirmListener.booleanremoveFlowListener(FlowListener listener)Deprecated.booleanremoveReturnListener(ReturnListener listener)Remove aReturnListener.AMQCommandrpc(Method method)Protected API - sends aMethodto the broker and waits for the next in-bound Command from the broker: only for use from non-connection-MainLoop threads!voidsetDefaultConsumer(Consumer consumer)Sets the current default consumer.AMQImpl.Tx.CommitOktxCommit()Public API - Commits a TX transaction on this channel.AMQImpl.Tx.RollbackOktxRollback()Public API - Rolls back a TX transaction on this channel.AMQImpl.Tx.SelectOktxSelect()Public API - Enables TX mode on this channel.booleanwaitForConfirms()Wait until all messages published since the last call have been either ack'd or nack'd by the broker.booleanwaitForConfirms(long timeout)Wait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses.voidwaitForConfirmsOrDie()Wait until all messages published since the last call have been either ack'd or nack'd by the broker.voidwaitForConfirmsOrDie(long timeout)Wait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses.-
Methods inherited from class com.rabbitmq.client.impl.AMQChannel
ensureIsOpen, exnWrappingRpc, getChannelNumber, getConnection, handleCompleteInboundCommand, handleFrame, isOutstandingRpc, nextOutstandingRpc, notifyOutstandingRpc, quiescingRpc, quiescingTransmit, quiescingTransmit, rpc, rpc, toString, transmit, transmit, wrap, wrap, wrapTimeoutException
-
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.Channel
getChannelNumber, getConnection
-
Methods inherited from interface com.rabbitmq.client.ShutdownNotifier
addShutdownListener, getCloseReason, isOpen, notifyListeners, removeShutdownListener
-
-
-
-
Field Detail
-
metricsCollector
protected final MetricsCollector metricsCollector
-
-
Constructor Detail
-
ChannelN
public ChannelN(AMQConnection connection, int channelNumber, ConsumerWorkService workService)
Construct a new channel on the given connection with the given channel number. Usually not called directly - call Connection.createChannel instead.- Parameters:
connection- The connection associated with this channelchannelNumber- The channel number to be associated with this channelworkService- service for managing this channel's consumer callbacks- See Also:
Connection.createChannel()
-
ChannelN
public ChannelN(AMQConnection connection, int channelNumber, ConsumerWorkService workService, MetricsCollector metricsCollector)
Construct a new channel on the given connection with the given channel number. Usually not called directly - call Connection.createChannel instead.- Parameters:
connection- The connection associated with this channelchannelNumber- The channel number to be associated with this channelworkService- service for managing this channel's consumer callbacksmetricsCollector- service for managing metrics- See Also:
Connection.createChannel()
-
-
Method Detail
-
open
public void open() throws IOExceptionPackage method: open the channel. This is only called fromChannelManager.- Throws:
IOException- if any problem is encountered
-
addReturnListener
public void addReturnListener(ReturnListener listener)
Description copied from interface:ChannelAdd aReturnListener.- Specified by:
addReturnListenerin interfaceChannel- Parameters:
listener- the listener to add
-
removeReturnListener
public boolean removeReturnListener(ReturnListener listener)
Description copied from interface:ChannelRemove aReturnListener.- Specified by:
removeReturnListenerin interfaceChannel- Parameters:
listener- the listener to remove- Returns:
trueif the listener was found and removed,falseotherwise
-
clearReturnListeners
public void clearReturnListeners()
Description copied from interface:ChannelRemove allReturnListeners.- Specified by:
clearReturnListenersin interfaceChannel
-
addFlowListener
@Deprecated public void addFlowListener(FlowListener listener)
Deprecated.Description copied from interface:ChannelAdd aFlowListener. Deprecated, superseded by TCP back pressure. Will be removed in next major release.- Specified by:
addFlowListenerin interfaceChannel- Parameters:
listener- the listener to add- See Also:
- Resource-driven alarms
-
removeFlowListener
@Deprecated public boolean removeFlowListener(FlowListener listener)
Deprecated.Description copied from interface:ChannelRemove aFlowListener. Deprecated, superseded by TCP back pressure. Will be removed in next major release.- Specified by:
removeFlowListenerin interfaceChannel- Parameters:
listener- the listener to remove- Returns:
trueif the listener was found and removed,falseotherwise- See Also:
- Resource-driven alarms
-
clearFlowListeners
@Deprecated public void clearFlowListeners()
Deprecated.Description copied from interface:ChannelRemove allFlowListeners. Deprecated, superseded by TCP back pressure. Will be removed in next major release.- Specified by:
clearFlowListenersin interfaceChannel- See Also:
- Resource-driven alarms
-
addConfirmListener
public void addConfirmListener(ConfirmListener listener)
Description copied from interface:ChannelAdd aConfirmListener.- Specified by:
addConfirmListenerin interfaceChannel- Parameters:
listener- the listener to add
-
removeConfirmListener
public boolean removeConfirmListener(ConfirmListener listener)
Description copied from interface:ChannelRemove aConfirmListener.- Specified by:
removeConfirmListenerin interfaceChannel- Parameters:
listener- the listener to remove- Returns:
trueif the listener was found and removed,falseotherwise
-
clearConfirmListeners
public void clearConfirmListeners()
Description copied from interface:ChannelRemove allConfirmListeners.- Specified by:
clearConfirmListenersin interfaceChannel
-
waitForConfirms
public boolean waitForConfirms() throws InterruptedExceptionWait until all messages published since the last call have been either ack'd or nack'd by the broker. Note, when called on a non-Confirm channel, waitForConfirms throws an IllegalStateException.- Specified by:
waitForConfirmsin interfaceChannel- Returns:
- whether all the messages were ack'd (and none were nack'd)
- Throws:
InterruptedException
-
waitForConfirms
public boolean waitForConfirms(long timeout) throws InterruptedException, TimeoutExceptionWait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses. If the timeout expires a TimeoutException is thrown. When called on a non-Confirm channel, waitForConfirms throws an IllegalStateException.- Specified by:
waitForConfirmsin interfaceChannel- Returns:
- whether all the messages were ack'd (and none were nack'd)
- Throws:
InterruptedExceptionTimeoutException
-
waitForConfirmsOrDie
public void waitForConfirmsOrDie() throws IOException, InterruptedExceptionWait until all messages published since the last call have been either ack'd or nack'd by the broker. If any of the messages were nack'd, waitForConfirmsOrDie will throw an IOException. When called on a non-Confirm channel, it will throw an IllegalStateException.- Specified by:
waitForConfirmsOrDiein interfaceChannel- Throws:
IOExceptionInterruptedException
-
waitForConfirmsOrDie
public void waitForConfirmsOrDie(long timeout) throws IOException, InterruptedException, TimeoutExceptionWait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses. If the timeout expires a TimeoutException is thrown. If any of the messages were nack'd, waitForConfirmsOrDie will throw an IOException. When called on a non-Confirm channel, it will throw an IllegalStateException.- Specified by:
waitForConfirmsOrDiein interfaceChannel- Throws:
IOExceptionInterruptedExceptionTimeoutException
-
getDefaultConsumer
public Consumer getDefaultConsumer()
Returns the current default consumer.- Specified by:
getDefaultConsumerin interfaceChannel- Returns:
- an interface to the current default consumer.
-
setDefaultConsumer
public void setDefaultConsumer(Consumer consumer)
Sets the current default consumer. A null argument is interpreted to mean "do not use a default consumer".- Specified by:
setDefaultConsumerin interfaceChannel- Parameters:
consumer- the consumer to use, or null indicating "don't use one".
-
processShutdownSignal
public void processShutdownSignal(ShutdownSignalException signal, boolean ignoreClosed, boolean notifyRpc)
Protected API - overridden to quiesce consumer work and broadcast the signal to all consumers after calling the superclass's method.- Overrides:
processShutdownSignalin classAMQChannel- Parameters:
signal- the signal to handleignoreClosed- the flag indicating whether to ignore the AlreadyClosedException thrown when the channel is already closednotifyRpc- the flag indicating whether any remaining rpc continuation should be notified with the given signal
-
processAsync
public boolean processAsync(Command command) throws IOException
Protected API - Filters the inbound command stream, processing Basic.Deliver, Basic.Return and Channel.Close specially. If we're in quiescing mode, all inbound commands are ignored, except for Channel.Close and Channel.CloseOk.- Specified by:
processAsyncin classAMQChannel- Parameters:
command- the command to handle asynchronously- Returns:
- true if we handled the command; otherwise the caller should consider it "unhandled"
- Throws:
IOException
-
processDelivery
protected void processDelivery(Command command, AMQImpl.Basic.Deliver method)
-
close
public void close() throws IOException, TimeoutExceptionPublic API - Close this channel with theAMQP.REPLY_SUCCESSclose code and message 'OK'.- Specified by:
closein interfaceChannel- Throws:
IOException- if an error is encounteredTimeoutException
-
close
public void close(int closeCode, String closeMessage) throws IOException, TimeoutExceptionPublic API - Close this channel.- Specified by:
closein interfaceChannel- 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 error is encounteredTimeoutException
-
abort
public void abort() throws IOExceptionPublic API - Abort this channel with theAMQP.REPLY_SUCCESSclose code and message 'OK'. Forces the channel to close and waits for the close operation to complete. Any encountered exceptions in the close operation are silently discarded.- Specified by:
abortin interfaceChannel- Throws:
IOException
-
abort
public void abort(int closeCode, String closeMessage) throws IOExceptionPublic API - Abort this channel. Forces the channel to close and waits for the close operation to complete. Any encountered exceptions in the close operation are silently discarded.- Specified by:
abortin interfaceChannel- Throws:
IOException
-
close
protected void close(int closeCode, String closeMessage, boolean initiatedByApplication, Throwable cause, boolean abort) throws IOException, TimeoutExceptionProtected API - Close channel with code and message, indicating the source of the closure and a causing exception (null if none).- Parameters:
closeCode- the close code (See under "Reply Codes" in the AMQP specification)closeMessage- a message indicating the reason for closing the connectioninitiatedByApplication- true if this comes from an API call, false otherwisecause- exception triggering closeabort- true if we should close and ignore errors- Throws:
IOException- if an error is encounteredTimeoutException
-
basicQos
public void basicQos(int prefetchSize, int prefetchCount, boolean global) throws IOExceptionPublic API - Request specific "quality of service" settings.These settings impose limits on the amount of data the server will deliver to consumers before requiring acknowledgements. Thus they provide a means of consumer-initiated flow control.
Note the prefetch count must be between 0 and 65535 (unsigned short in AMQP 0-9-1).
- Specified by:
basicQosin interfaceChannel- Parameters:
prefetchSize- maximum amount of content (measured in octets) that the server will deliver, 0 if unlimitedprefetchCount- maximum number of messages that the server will deliver, 0 if unlimitedglobal- true if the settings should be applied to the entire channel rather than each consumer- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Qos
-
basicQos
public void basicQos(int prefetchCount, boolean global) throws IOExceptionPublic API - Request a specific prefetchCount "quality of service" settings for this channel.Note the prefetch count must be between 0 and 65535 (unsigned short in AMQP 0-9-1).
- Specified by:
basicQosin interfaceChannel- Parameters:
prefetchCount- maximum number of messages that the server will deliver, 0 if unlimitedglobal- true if the settings should be applied to the entire channel rather than each consumer- Throws:
IOException- if an error is encountered- See Also:
Channel.basicQos(int, int, boolean)
-
basicQos
public void basicQos(int prefetchCount) throws IOExceptionPublic API - Request a specific prefetchCount "quality of service" settings for this channel.Note the prefetch count must be between 0 and 65535 (unsigned short in AMQP 0-9-1).
- Specified by:
basicQosin interfaceChannel- Parameters:
prefetchCount- maximum number of messages that the server will deliver, 0 if unlimited- Throws:
IOException- if an error is encountered- See Also:
Channel.basicQos(int, int, boolean)
-
basicPublish
public void basicPublish(String exchange, String routingKey, AMQP.BasicProperties props, byte[] body) throws IOException
Public API - Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations ofChannel#basicPublishwill eventually block if a resource-driven alarm is in effect.- Specified by:
basicPublishin interfaceChannel- Parameters:
exchange- the exchange to publish the message toroutingKey- the routing keyprops- other properties for the message - routing headers etcbody- the message body- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Publish, Resource-driven alarms
-
basicPublish
public void basicPublish(String exchange, String routingKey, boolean mandatory, AMQP.BasicProperties props, byte[] body) throws IOException
Public API - Publish a message. Invocations ofChannel#basicPublishwill eventually block if a resource-driven alarm is in effect.- Specified by:
basicPublishin interfaceChannel- Parameters:
exchange- the exchange to publish the message toroutingKey- the routing keymandatory- true if the 'mandatory' flag is to be setprops- other properties for the message - routing headers etcbody- the message body- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Publish, Resource-driven alarms
-
basicPublish
public void basicPublish(String exchange, String routingKey, boolean mandatory, boolean immediate, AMQP.BasicProperties props, byte[] body) throws IOException
Public API - Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations ofChannel#basicPublishwill eventually block if a resource-driven alarm is in effect.- Specified by:
basicPublishin interfaceChannel- Parameters:
exchange- the exchange to publish the message toroutingKey- the routing keymandatory- true if the 'mandatory' flag is to be setimmediate- true if the 'immediate' flag is to be set. Note that the RabbitMQ server does not support this flag.props- other properties for the message - routing headers etcbody- the message body- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Publish, Resource-driven alarms
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, String type, boolean durable, boolean autoDelete, Map<String,Object> arguments) throws IOException
Public API - Declare an exchange.- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)autoDelete- true if the server should delete the exchange when it is no longer in usearguments- other properties (construction arguments) for the exchange- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, Map<String,Object> arguments) throws IOException
Public API - Declare an exchange.- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)autoDelete- true if the server should delete the exchange when it is no longer in usearguments- other properties (construction arguments) for the exchange- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclareNoWait
public void exchangeDeclareNoWait(String exchange, String type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
Description copied from interface:ChannelLikeChannel.exchangeDeclare(String, String, boolean, boolean, java.util.Map)but sets nowait parameter to true and returns nothing (as there will be no response from the server).- Specified by:
exchangeDeclareNoWaitin interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)autoDelete- true if the server should delete the exchange when it is no longer in useinternal- true if the exchange is internal, i.e. can't be directly published to by a client.arguments- other properties (construction arguments) for the exchange- Throws:
IOException- if an error is encountered
-
exchangeDeclareNoWait
public void exchangeDeclareNoWait(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
Description copied from interface:ChannelLikeChannel.exchangeDeclare(String, String, boolean, boolean, java.util.Map)but sets nowait parameter to true and returns nothing (as there will be no response from the server).- Specified by:
exchangeDeclareNoWaitin interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)autoDelete- true if the server should delete the exchange when it is no longer in useinternal- true if the exchange is internal, i.e. can't be directly published to by a client.arguments- other properties (construction arguments) for the exchange- Throws:
IOException- if an error is encountered
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, String type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
Public API - Declare an exchange, via an interface that allows the complete set of arguments.- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)autoDelete- true if the server should delete the exchange when it is no longer in useinternal- true if the exchange is internal, i.e. can't be directly published to by a client.arguments- other properties (construction arguments) for the exchange- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
Public API - Declare an exchange, via an interface that allows the complete set of arguments.- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)autoDelete- true if the server should delete the exchange when it is no longer in useinternal- true if the exchange is internal, i.e. can't be directly published to by a client.arguments- other properties (construction arguments) for the exchange- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, String type, boolean durable) throws IOException
Public API - Actively declare a non-autodelete exchange with no extra arguments- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable) throws IOException
Public API - Actively declare a non-autodelete exchange with no extra arguments- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange typedurable- true if we are declaring a durable exchange (the exchange will survive a server restart)- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, String type) throws IOException
Public API - Actively declare a non-autodelete, non-durable exchange with no extra arguments- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange type- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclare
public AMQImpl.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type) throws IOException
Public API - Actively declare a non-autodelete, non-durable exchange with no extra arguments- Specified by:
exchangeDeclarein interfaceChannel- Parameters:
exchange- the name of the exchangetype- the exchange type- Returns:
- a declaration-confirm method to indicate the exchange was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Declare,AMQP.Exchange.DeclareOk
-
exchangeDeclarePassive
public AMQImpl.Exchange.DeclareOk exchangeDeclarePassive(String exchange) throws IOException
Public API - Declare an exchange passively; that is, check if the named exchange exists.- Specified by:
exchangeDeclarePassivein interfaceChannel- Parameters:
exchange- check the existence of an exchange named this- Throws:
IOException- the server will raise a 404 channel exception if the named exchange does not exist.
-
exchangeDelete
public AMQImpl.Exchange.DeleteOk exchangeDelete(String exchange, boolean ifUnused) throws IOException
Public API - Delete an exchange- Specified by:
exchangeDeletein interfaceChannel- Parameters:
exchange- the name of the exchangeifUnused- true to indicate that the exchange is only to be deleted if it is unused- Returns:
- a deletion-confirm method to indicate the exchange was successfully deleted
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Delete,AMQP.Exchange.DeleteOk
-
exchangeDeleteNoWait
public void exchangeDeleteNoWait(String exchange, boolean ifUnused) throws IOException
Public API - LikeChannel.exchangeDelete(String, boolean)but sets nowait parameter to true and returns void (as there will be no response from the server).- Specified by:
exchangeDeleteNoWaitin interfaceChannel- Parameters:
exchange- the name of the exchangeifUnused- true to indicate that the exchange is only to be deleted if it is unused- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Delete,AMQP.Exchange.DeleteOk
-
exchangeDelete
public AMQImpl.Exchange.DeleteOk exchangeDelete(String exchange) throws IOException
Public API - Delete an exchange, without regard for whether it is in use or not- Specified by:
exchangeDeletein interfaceChannel- Parameters:
exchange- the name of the exchange- Returns:
- a deletion-confirm method to indicate the exchange was successfully deleted
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Delete,AMQP.Exchange.DeleteOk
-
exchangeBind
public AMQImpl.Exchange.BindOk exchangeBind(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
Public API - Bind an exchange to an exchange.- Specified by:
exchangeBindin interfaceChannel- Parameters:
destination- the name of the exchange to which messages flow across the bindingsource- the name of the exchange from which messages flow across the bindingroutingKey- the routing key to use for the bindingarguments- other properties (binding parameters)- Returns:
- a binding-confirm method if the binding was successfully created
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Bind,AMQP.Exchange.BindOk
-
exchangeBindNoWait
public void exchangeBindNoWait(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
Public API - LikeChannel.exchangeBind(String, String, String, java.util.Map)but sets nowait parameter to true and returns void (as there will be no response from the server).- Specified by:
exchangeBindNoWaitin interfaceChannel- Parameters:
destination- the name of the exchange to which messages flow across the bindingsource- the name of the exchange from which messages flow across the bindingroutingKey- the routing key to use for the bindingarguments- other properties (binding parameters)- Throws:
IOException- if an error is encountered
-
exchangeBind
public AMQImpl.Exchange.BindOk exchangeBind(String destination, String source, String routingKey) throws IOException
Public API - Bind an exchange to an exchange, with no extra arguments.- Specified by:
exchangeBindin interfaceChannel- Parameters:
destination- the name of the exchange to which messages flow across the bindingsource- the name of the exchange from which messages flow across the bindingroutingKey- the routing key to use for the binding- Returns:
- a binding-confirm method if the binding was successfully created
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Bind,AMQP.Exchange.BindOk
-
exchangeUnbind
public AMQImpl.Exchange.UnbindOk exchangeUnbind(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
Public API - Unbind an exchange from an exchange.- Specified by:
exchangeUnbindin interfaceChannel- Parameters:
destination- the name of the exchange to which messages flow across the bindingsource- the name of the exchange from which messages flow across the bindingroutingKey- the routing key to use for the bindingarguments- other properties (binding parameters)- Returns:
- a binding-confirm method if the binding was successfully created
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Bind,AMQP.Exchange.BindOk
-
exchangeUnbind
public AMQImpl.Exchange.UnbindOk exchangeUnbind(String destination, String source, String routingKey) throws IOException
Public API - Unbind an exchange from an exchange, with no extra arguments.- Specified by:
exchangeUnbindin interfaceChannel- Parameters:
destination- the name of the exchange to which messages flow across the bindingsource- the name of the exchange from which messages flow across the bindingroutingKey- the routing key to use for the binding- Returns:
- a binding-confirm method if the binding was successfully created
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Exchange.Bind,AMQP.Exchange.BindOk
-
exchangeUnbindNoWait
public void exchangeUnbindNoWait(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
Public API - Same asChannel.exchangeUnbind(String, String, String, java.util.Map)but sets no-wait parameter to true and returns nothing (as there will be no response from the server).- Specified by:
exchangeUnbindNoWaitin interfaceChannel- Parameters:
destination- the name of the exchange to which messages flow across the bindingsource- the name of the exchange from which messages flow across the bindingroutingKey- the routing key to use for the bindingarguments- other properties (binding parameters)- Throws:
IOException- if an error is encountered
-
queueDeclare
public AMQImpl.Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, boolean autoDelete, Map<String,Object> arguments) throws IOException
Public API - Declare a queue- Specified by:
queueDeclarein interfaceChannel- Parameters:
queue- the name of the queuedurable- true if we are declaring a durable queue (the queue will survive a server restart)exclusive- true if we are declaring an exclusive queue (restricted to this connection)autoDelete- true if we are declaring an autodelete queue (server will delete it when no longer in use)arguments- other properties (construction arguments) for the queue- Returns:
- a declaration-confirm method to indicate the queue was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Declare,AMQP.Queue.DeclareOk
-
queueDeclare
public AMQP.Queue.DeclareOk queueDeclare() throws IOException
Public API - Actively declare a server-named exclusive, autodelete, non-durable queue. The name of the new queue is held in the "queue" field of theAMQP.Queue.DeclareOkresult.- Specified by:
queueDeclarein interfaceChannel- Returns:
- a declaration-confirm method to indicate the queue was successfully declared
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Declare,AMQP.Queue.DeclareOk
-
queueDeclareNoWait
public void queueDeclareNoWait(String queue, boolean durable, boolean exclusive, boolean autoDelete, Map<String,Object> arguments) throws IOException
Public API - LikeChannel.queueDeclare(String, boolean, boolean, boolean, java.util.Map)but sets nowait flag to true and returns no result (as there will be no response from the server).- Specified by:
queueDeclareNoWaitin interfaceChannel- Parameters:
queue- the name of the queuedurable- true if we are declaring a durable queue (the queue will survive a server restart)exclusive- true if we are declaring an exclusive queue (restricted to this connection)autoDelete- true if we are declaring an autodelete queue (server will delete it when no longer in use)arguments- other properties (construction arguments) for the queue- Throws:
IOException- if an error is encountered
-
queueDeclarePassive
public AMQImpl.Queue.DeclareOk queueDeclarePassive(String queue) throws IOException
Public API - Declare a queue passively; i.e., check if it exists. In AMQP 0-9-1, all arguments aside from nowait are ignored; and sending nowait makes this method a no-op, so we default it to false.- Specified by:
queueDeclarePassivein interfaceChannel- Parameters:
queue- the name of the queue- Returns:
- a declaration-confirm method to indicate the queue exists
- Throws:
IOException- if an error is encountered, including if the queue does not exist and if the queue is exclusively owned by another connection.- See Also:
AMQP.Queue.Declare,AMQP.Queue.DeclareOk
-
messageCount
public long messageCount(String queue) throws IOException
Public API - Returns the number of messages in a queue ready to be delivered to consumers. This method assumes the queue exists. If it doesn't, the channels will be closed with an exception.- Specified by:
messageCountin interfaceChannel- Parameters:
queue- the name of the queue- Returns:
- the number of messages in ready state
- Throws:
IOException- Problem transmitting method.
-
consumerCount
public long consumerCount(String queue) throws IOException
Public API - Returns the number of consumers on a queue. This method assumes the queue exists. If it doesn't, the channel will be closed with an exception.- Specified by:
consumerCountin interfaceChannel- Parameters:
queue- the name of the queue- Returns:
- the number of consumers
- Throws:
IOException- Problem transmitting method.
-
queueDelete
public AMQImpl.Queue.DeleteOk queueDelete(String queue, boolean ifUnused, boolean ifEmpty) throws IOException
Public API - Delete a queue- Specified by:
queueDeletein interfaceChannel- Parameters:
queue- the name of the queueifUnused- true if the queue should be deleted only if not in useifEmpty- true if the queue should be deleted only if empty- Returns:
- a deletion-confirm method to indicate the queue was successfully deleted
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Delete,AMQP.Queue.DeleteOk
-
queueDeleteNoWait
public void queueDeleteNoWait(String queue, boolean ifUnused, boolean ifEmpty) throws IOException
Description copied from interface:ChannelLikeChannel.queueDelete(String, boolean, boolean)but sets nowait parameter to true and returns nothing (as there will be no response from the server).- Specified by:
queueDeleteNoWaitin interfaceChannel- Parameters:
queue- the name of the queueifUnused- true if the queue should be deleted only if not in useifEmpty- true if the queue should be deleted only if empty- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Delete,AMQP.Queue.DeleteOk
-
queueDelete
public AMQImpl.Queue.DeleteOk queueDelete(String queue) throws IOException
Public API - Delete a queue, without regard for whether it is in use or has messages on it- Specified by:
queueDeletein interfaceChannel- Parameters:
queue- the name of the queue- Returns:
- a deletion-confirm method to indicate the queue was successfully deleted
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Delete,AMQP.Queue.DeleteOk
-
queueBind
public AMQImpl.Queue.BindOk queueBind(String queue, String exchange, String routingKey, Map<String,Object> arguments) throws IOException
Public API - Bind a queue to an exchange.- Specified by:
queueBindin interfaceChannel- Parameters:
queue- the name of the queueexchange- the name of the exchangeroutingKey- the routing key to use for the bindingarguments- other properties (binding parameters)- Returns:
- a binding-confirm method if the binding was successfully created
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Bind,AMQP.Queue.BindOk
-
queueBind
public AMQImpl.Queue.BindOk queueBind(String queue, String exchange, String routingKey) throws IOException
Public API - Bind a queue to an exchange, with no extra arguments.- Specified by:
queueBindin interfaceChannel- Parameters:
queue- the name of the queueexchange- the name of the exchangeroutingKey- the routing key to use for the binding- Returns:
- a binding-confirm method if the binding was successfully created
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Bind,AMQP.Queue.BindOk
-
queueBindNoWait
public void queueBindNoWait(String queue, String exchange, String routingKey, Map<String,Object> arguments) throws IOException
Public API - Same asChannel.queueBind(String, String, String, java.util.Map)but sets nowait parameter to true and returns void (as there will be no response from the server).- Specified by:
queueBindNoWaitin interfaceChannel- Parameters:
queue- the name of the queueexchange- the name of the exchangeroutingKey- the routing key to use for the bindingarguments- other properties (binding parameters)- Throws:
IOException- if an error is encountered
-
queueUnbind
public AMQImpl.Queue.UnbindOk queueUnbind(String queue, String exchange, String routingKey, Map<String,Object> arguments) throws IOException
Public API - Unbind a queue from an exchange.- Specified by:
queueUnbindin interfaceChannel- Parameters:
queue- the name of the queueexchange- the name of the exchangeroutingKey- the routing key to use for the bindingarguments- other properties (binding parameters)- Returns:
- an unbinding-confirm method if the binding was successfully deleted
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Unbind,AMQP.Queue.UnbindOk
-
queuePurge
public AMQImpl.Queue.PurgeOk queuePurge(String queue) throws IOException
Public API - Purges the contents of the given queue.- Specified by:
queuePurgein interfaceChannel- Parameters:
queue- the name of the queue- Returns:
- a purge-confirm method if the purge was executed successfully
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Purge,AMQP.Queue.PurgeOk
-
queueUnbind
public AMQImpl.Queue.UnbindOk queueUnbind(String queue, String exchange, String routingKey) throws IOException
Public API - Unbinds a queue from an exchange, with no extra arguments.- Specified by:
queueUnbindin interfaceChannel- Parameters:
queue- the name of the queueexchange- the name of the exchangeroutingKey- the routing key to use for the binding- Returns:
- an unbinding-confirm method if the binding was successfully deleted
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Queue.Unbind,AMQP.Queue.UnbindOk
-
basicGet
public GetResponse basicGet(String queue, boolean autoAck) throws IOException
Public API - Retrieve a message from a queue usingAMQP.Basic.Get- Specified by:
basicGetin interfaceChannel- Parameters:
queue- the name of the queueautoAck- true if the server should consider messages acknowledged once delivered; false if the server should expect explicit acknowledgements- Returns:
- a
GetResponsecontaining the retrieved message data - Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Get,AMQP.Basic.GetOk,AMQP.Basic.GetEmpty
-
basicAck
public void basicAck(long deliveryTag, boolean multiple) throws IOExceptionPublic API - Acknowledge one or several received messages. Supply the deliveryTag from theAMQP.Basic.GetOkorAMQP.Basic.Delivermethod containing the received message being acknowledged.- Specified by:
basicAckin interfaceChannel- Parameters:
deliveryTag- the tag from the receivedAMQP.Basic.GetOkorAMQP.Basic.Delivermultiple- true to acknowledge all messages up to and including the supplied delivery tag; false to acknowledge just the supplied delivery tag.- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Ack
-
basicNack
public void basicNack(long deliveryTag, boolean multiple, boolean requeue) throws IOExceptionPublic API - Reject one or several received messages. Supply thedeliveryTagfrom theAMQP.Basic.GetOkorAMQP.Basic.GetOkmethod containing the message to be rejected.- Specified by:
basicNackin interfaceChannel- Parameters:
deliveryTag- the tag from the receivedAMQP.Basic.GetOkorAMQP.Basic.Delivermultiple- true to reject all messages up to and including the supplied delivery tag; false to reject just the supplied delivery tag.requeue- true if the rejected message(s) should be requeued rather than discarded/dead-lettered- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Nack
-
basicReject
public void basicReject(long deliveryTag, boolean requeue) throws IOExceptionPublic API - Reject a message. Supply the deliveryTag from theAMQP.Basic.GetOkorAMQP.Basic.Delivermethod containing the received message being rejected.- Specified by:
basicRejectin interfaceChannel- Parameters:
deliveryTag- the tag from the receivedAMQP.Basic.GetOkorAMQP.Basic.Deliverrequeue- true if the rejected message should be requeued rather than discarded/dead-lettered- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Reject
-
basicConsume
public String basicConsume(String queue, Consumer callback) throws IOException
Public API - Start a non-nolocal, non-exclusive consumer, with explicit acknowledgement and a server-generated consumerTag.- Specified by:
basicConsumein interfaceChannel- Parameters:
queue- the name of the queuecallback- an interface to the consumer object- Returns:
- the consumerTag generated by the server
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Consume,AMQP.Basic.ConsumeOk,Channel.basicAck(long, boolean),Channel.basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
-
basicConsume
public String basicConsume(String queue, boolean autoAck, Consumer callback) throws IOException
Public API - Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag.- Specified by:
basicConsumein interfaceChannel- Parameters:
queue- the name of the queueautoAck- true if the server should consider messages acknowledged once delivered; false if the server should expect explicit acknowledgementscallback- an interface to the consumer object- Returns:
- the consumerTag generated by the server
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Consume,AMQP.Basic.ConsumeOk,Channel.basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
-
basicConsume
public String basicConsume(String queue, boolean autoAck, Map<String,Object> arguments, Consumer callback) throws IOException
Public API - Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag and specified arguments.- Specified by:
basicConsumein interfaceChannel- Parameters:
queue- the name of the queueautoAck- true if the server should consider messages acknowledged once delivered; false if the server should expect explicit acknowledgementsarguments- a set of arguments for the consumecallback- an interface to the consumer object- Returns:
- the consumerTag generated by the server
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Consume,AMQP.Basic.ConsumeOk,Channel.basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
-
basicConsume
public String basicConsume(String queue, boolean autoAck, String consumerTag, Consumer callback) throws IOException
Public API - Start a non-nolocal, non-exclusive consumer.- Specified by:
basicConsumein interfaceChannel- Parameters:
queue- the name of the queueautoAck- true if the server should consider messages acknowledged once delivered; false if the server should expect explicit acknowledgementsconsumerTag- a client-generated consumer tag to establish contextcallback- an interface to the consumer object- Returns:
- the consumerTag associated with the new consumer
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Consume,AMQP.Basic.ConsumeOk,Channel.basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
-
basicConsume
public String basicConsume(String queue, boolean autoAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String,Object> arguments, Consumer callback) throws IOException
Public API - Start a consumer. Calls the consumer'sConsumer.handleConsumeOk(java.lang.String)method.- Specified by:
basicConsumein interfaceChannel- Parameters:
queue- the name of the queueautoAck- true if the server should consider messages acknowledged once delivered; false if the server should expect explicit acknowledgementsconsumerTag- a client-generated consumer tag to establish contextnoLocal- true if the server should not deliver to this consumer messages published on this channel's connectionexclusive- true if this is an exclusive consumerarguments- a set of arguments for the consumecallback- an interface to the consumer object- Returns:
- the consumerTag associated with the new consumer
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Basic.Consume,AMQP.Basic.ConsumeOk
-
basicCancel
public void basicCancel(String consumerTag) throws IOException
Public API - Cancel a consumer. Calls the consumer'sConsumer.handleCancelOk(java.lang.String)method.- Specified by:
basicCancelin interfaceChannel- Parameters:
consumerTag- a client- or server-generated consumer tag to establish context- Throws:
IOException- if an error is encountered, or if the consumerTag is unknown- See Also:
AMQP.Basic.Cancel,AMQP.Basic.CancelOk
-
basicRecover
public AMQImpl.Basic.RecoverOk basicRecover() throws IOException
Public API -Ask the broker to resend unacknowledged messages. In 0-8 basic.recover is asynchronous; in 0-9-1 it is synchronous, and the new, deprecated method basic.recover_async is asynchronous.
Equivalent to callingbasicRecover(true), messages will be requeued and possibly delivered to a different consumer.- Specified by:
basicRecoverin interfaceChannel- Throws:
IOException- See Also:
Channel.basicRecover(boolean)
-
basicRecover
public AMQImpl.Basic.RecoverOk basicRecover(boolean requeue) throws IOException
Public API - Ask the broker to resend unacknowledged messages. In 0-8 basic.recover is asynchronous; in 0-9-1 it is synchronous, and the new, deprecated method basic.recover_async is asynchronous.- Specified by:
basicRecoverin interfaceChannel- Parameters:
requeue- If true, messages will be requeued and possibly delivered to a different consumer. If false, messages will be redelivered to the same consumer.- Throws:
IOException
-
txSelect
public AMQImpl.Tx.SelectOk txSelect() throws IOException
Public API - Enables TX mode on this channel.- Specified by:
txSelectin interfaceChannel- Returns:
- a transaction-selection method to indicate the transaction was successfully initiated
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Tx.Select,AMQP.Tx.SelectOk
-
txCommit
public AMQImpl.Tx.CommitOk txCommit() throws IOException
Public API - Commits a TX transaction on this channel.- Specified by:
txCommitin interfaceChannel- Returns:
- a transaction-commit method to indicate the transaction was successfully committed
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Tx.Commit,AMQP.Tx.CommitOk
-
txRollback
public AMQImpl.Tx.RollbackOk txRollback() throws IOException
Public API - Rolls back a TX transaction on this channel.- Specified by:
txRollbackin interfaceChannel- Returns:
- a transaction-rollback method to indicate the transaction was successfully rolled back
- Throws:
IOException- if an error is encountered- See Also:
AMQP.Tx.Rollback,AMQP.Tx.RollbackOk
-
confirmSelect
public AMQImpl.Confirm.SelectOk confirmSelect() throws IOException
Public API - Enables publisher acknowledgements on this channel.- Specified by:
confirmSelectin interfaceChannel- Throws:
IOException- if an error is encountered- See Also:
AMQP.Confirm.Select
-
flowBlocked
@Deprecated public boolean flowBlocked()
Deprecated.Public API - Deprecated, superseded by TCP back pressure. Will be removed in next major release.- Specified by:
flowBlockedin interfaceChannel- See Also:
- Resource-driven alarms
-
getNextPublishSeqNo
public long getNextPublishSeqNo()
Public API - When in confirm mode, returns the sequence number of the next message to be published.- Specified by:
getNextPublishSeqNoin interfaceChannel- Returns:
- the sequence number of the next message to be published
-
asyncRpc
public void asyncRpc(Method method) throws IOException
Description copied from interface:ChannelAsynchronously send a method over this channel.- Specified by:
asyncRpcin interfaceChannel- Parameters:
method- method to transmit over this channel.- Throws:
IOException- Problem transmitting method.
-
rpc
public AMQCommand rpc(Method method) throws IOException
Description copied from class:AMQChannelProtected API - sends aMethodto the broker and waits for the next in-bound Command from the broker: only for use from non-connection-MainLoop threads!- Specified by:
rpcin interfaceChannel- Overrides:
rpcin classAMQChannel- Parameters:
method- method to transmit over this channel.- Returns:
- command response to method. Caller should cast as appropriate.
- Throws:
IOException- Problem transmitting method.
-
enqueueRpc
public void enqueueRpc(AMQChannel.RpcContinuation k)
- Overrides:
enqueueRpcin classAMQChannel
-
markRpcFinished
protected void markRpcFinished()
- Overrides:
markRpcFinishedin classAMQChannel
-
-