public interface Channel extends ShutdownNotifier, AutoCloseable
Channel
instances must not be shared between
threads. Applications
should prefer using a Channel
per thread
instead of sharing the same Channel
across
multiple threads. While some operations on channels are safe to invoke
concurrently, some are not and will result in incorrect frame interleaving
on the wire. Sharing channels between threads will also interfere with
Publisher Confirms.
As such, applications need to use a Channel
per thread.
Modifier and Type | Method and Description |
---|---|
void |
abort()
Abort this channel with the
AMQP.REPLY_SUCCESS close code
and message 'OK'. |
void |
abort(int closeCode,
String closeMessage)
Abort this channel.
|
ConfirmListener |
addConfirmListener(ConfirmCallback ackCallback,
ConfirmCallback nackCallback)
Add a lambda-based
ConfirmListener . |
void |
addConfirmListener(ConfirmListener listener)
Add a
ConfirmListener . |
ReturnListener |
addReturnListener(ReturnCallback returnCallback)
Add a lambda-based
ReturnListener . |
void |
addReturnListener(ReturnListener listener)
Add a
ReturnListener . |
CompletableFuture<Command> |
asyncCompletableRpc(Method method)
Asynchronously send a method over this channel.
|
void |
asyncRpc(Method method)
Asynchronously send a method over this channel.
|
void |
basicAck(long deliveryTag,
boolean multiple)
Acknowledge one or several received
messages.
|
void |
basicCancel(String consumerTag)
Cancel a consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
Consumer callback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag.
|
String |
basicConsume(String queue,
boolean autoAck,
DeliverCallback deliverCallback,
CancelCallback cancelCallback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag.
|
String |
basicConsume(String queue,
boolean autoAck,
DeliverCallback deliverCallback,
CancelCallback cancelCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag.
|
String |
basicConsume(String queue,
boolean autoAck,
DeliverCallback deliverCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag.
|
String |
basicConsume(String queue,
boolean autoAck,
Map<String,Object> arguments,
Consumer callback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag and specified arguments.
|
String |
basicConsume(String queue,
boolean autoAck,
Map<String,Object> arguments,
DeliverCallback deliverCallback,
CancelCallback cancelCallback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag and specified arguments.
|
String |
basicConsume(String queue,
boolean autoAck,
Map<String,Object> arguments,
DeliverCallback deliverCallback,
CancelCallback cancelCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag and specified arguments.
|
String |
basicConsume(String queue,
boolean autoAck,
Map<String,Object> arguments,
DeliverCallback deliverCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer, with
a server-generated consumerTag and specified arguments.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
boolean noLocal,
boolean exclusive,
Map<String,Object> arguments,
Consumer callback)
Start a consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
boolean noLocal,
boolean exclusive,
Map<String,Object> arguments,
DeliverCallback deliverCallback,
CancelCallback cancelCallback)
Start a consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
boolean noLocal,
boolean exclusive,
Map<String,Object> arguments,
DeliverCallback deliverCallback,
CancelCallback cancelCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
boolean noLocal,
boolean exclusive,
Map<String,Object> arguments,
DeliverCallback deliverCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
Consumer callback)
Start a non-nolocal, non-exclusive consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
DeliverCallback deliverCallback,
CancelCallback cancelCallback)
Start a non-nolocal, non-exclusive consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
DeliverCallback deliverCallback,
CancelCallback cancelCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer.
|
String |
basicConsume(String queue,
boolean autoAck,
String consumerTag,
DeliverCallback deliverCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer.
|
String |
basicConsume(String queue,
Consumer callback)
Start a non-nolocal, non-exclusive consumer, with
explicit acknowledgement and a server-generated consumerTag.
|
String |
basicConsume(String queue,
DeliverCallback deliverCallback,
CancelCallback cancelCallback)
Start a non-nolocal, non-exclusive consumer, with
explicit acknowledgement and a server-generated consumerTag.
|
String |
basicConsume(String queue,
DeliverCallback deliverCallback,
CancelCallback cancelCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer, with
explicit acknowledgement and a server-generated consumerTag.
|
String |
basicConsume(String queue,
DeliverCallback deliverCallback,
ConsumerShutdownSignalCallback shutdownSignalCallback)
Start a non-nolocal, non-exclusive consumer, with
explicit acknowledgement and a server-generated consumerTag.
|
GetResponse |
basicGet(String queue,
boolean autoAck)
Retrieve a message from a queue using
AMQP.Basic.Get |
void |
basicNack(long deliveryTag,
boolean multiple,
boolean requeue)
Reject one or several received messages.
|
void |
basicPublish(String exchange,
String routingKey,
AMQP.BasicProperties props,
byte[] body)
Publish a message.
|
void |
basicPublish(String exchange,
String routingKey,
boolean mandatory,
AMQP.BasicProperties props,
byte[] body)
Publish a message.
|
void |
basicPublish(String exchange,
String routingKey,
boolean mandatory,
boolean immediate,
AMQP.BasicProperties props,
byte[] body)
Publish a message.
|
void |
basicQos(int prefetchCount)
Request a specific prefetchCount "quality of service" settings
for this channel.
|
void |
basicQos(int prefetchCount,
boolean global)
Request a specific prefetchCount "quality of service" settings
for this channel.
|
void |
basicQos(int prefetchSize,
int prefetchCount,
boolean global)
Request specific "quality of service" settings.
|
AMQP.Basic.RecoverOk |
basicRecover()
Ask the broker to resend unacknowledged messages.
|
AMQP.Basic.RecoverOk |
basicRecover(boolean requeue)
Ask the broker to resend unacknowledged messages.
|
void |
basicReject(long deliveryTag,
boolean requeue)
Reject a message.
|
void |
clearConfirmListeners()
Remove all
ConfirmListener s. |
void |
clearReturnListeners()
Remove all
ReturnListener s. |
void |
close()
Close this channel with the
AMQP.REPLY_SUCCESS close code
and message 'OK'. |
void |
close(int closeCode,
String closeMessage)
Close this channel.
|
AMQP.Confirm.SelectOk |
confirmSelect()
Enables publisher acknowledgements on this channel.
|
long |
consumerCount(String queue)
Returns the number of consumers on a queue.
|
AMQP.Exchange.BindOk |
exchangeBind(String destination,
String source,
String routingKey)
Bind an exchange to an exchange, with no extra arguments.
|
AMQP.Exchange.BindOk |
exchangeBind(String destination,
String source,
String routingKey,
Map<String,Object> arguments)
Bind an exchange to an exchange.
|
void |
exchangeBindNoWait(String destination,
String source,
String routingKey,
Map<String,Object> arguments)
Like
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). |
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
BuiltinExchangeType type)
Actively declare a non-autodelete, non-durable exchange with no extra arguments
|
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
BuiltinExchangeType type,
boolean durable)
Actively declare a non-autodelete exchange with no extra arguments
|
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
BuiltinExchangeType type,
boolean durable,
boolean autoDelete,
boolean internal,
Map<String,Object> arguments)
Declare an exchange, via an interface that allows the complete set of
arguments.
|
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
BuiltinExchangeType type,
boolean durable,
boolean autoDelete,
Map<String,Object> arguments)
Declare an exchange.
|
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
String type)
Actively declare a non-autodelete, non-durable exchange with no extra arguments
|
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
String type,
boolean durable)
Actively declare a non-autodelete exchange with no extra arguments
|
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
String type,
boolean durable,
boolean autoDelete,
boolean internal,
Map<String,Object> arguments)
Declare an exchange, via an interface that allows the complete set of
arguments.
|
AMQP.Exchange.DeclareOk |
exchangeDeclare(String exchange,
String type,
boolean durable,
boolean autoDelete,
Map<String,Object> arguments)
Declare an exchange.
|
void |
exchangeDeclareNoWait(String exchange,
BuiltinExchangeType type,
boolean durable,
boolean autoDelete,
boolean internal,
Map<String,Object> arguments)
Like
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). |
void |
exchangeDeclareNoWait(String exchange,
String type,
boolean durable,
boolean autoDelete,
boolean internal,
Map<String,Object> arguments)
Like
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). |
AMQP.Exchange.DeclareOk |
exchangeDeclarePassive(String name)
Declare an exchange passively; that is, check if the named exchange exists.
|
AMQP.Exchange.DeleteOk |
exchangeDelete(String exchange)
Delete an exchange, without regard for whether it is in use or not
|
AMQP.Exchange.DeleteOk |
exchangeDelete(String exchange,
boolean ifUnused)
Delete an exchange
|
void |
exchangeDeleteNoWait(String exchange,
boolean ifUnused)
Like
exchangeDelete(String, boolean) but sets nowait parameter to true
and returns void (as there will be no response from the server). |
AMQP.Exchange.UnbindOk |
exchangeUnbind(String destination,
String source,
String routingKey)
Unbind an exchange from an exchange, with no extra arguments.
|
AMQP.Exchange.UnbindOk |
exchangeUnbind(String destination,
String source,
String routingKey,
Map<String,Object> arguments)
Unbind an exchange from an exchange.
|
void |
exchangeUnbindNoWait(String destination,
String source,
String routingKey,
Map<String,Object> arguments)
Same as
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). |
int |
getChannelNumber()
Retrieve this channel's channel number.
|
Connection |
getConnection()
Retrieve the connection which carries this channel.
|
Consumer |
getDefaultConsumer()
Get the current default consumer.
|
long |
getNextPublishSeqNo()
When in confirm mode, returns the sequence number of the next
message to be published.
|
long |
messageCount(String queue)
Returns the number of messages in a queue ready to be delivered
to consumers.
|
AMQP.Queue.BindOk |
queueBind(String queue,
String exchange,
String routingKey)
Bind a queue to an exchange, with no extra arguments.
|
AMQP.Queue.BindOk |
queueBind(String queue,
String exchange,
String routingKey,
Map<String,Object> arguments)
Bind a queue to an exchange.
|
void |
queueBindNoWait(String queue,
String exchange,
String routingKey,
Map<String,Object> arguments)
Same as
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.DeclareOk |
queueDeclare()
Actively declare a server-named exclusive, autodelete, non-durable queue.
|
AMQP.Queue.DeclareOk |
queueDeclare(String queue,
boolean durable,
boolean exclusive,
boolean autoDelete,
Map<String,Object> arguments)
Declare a queue
|
void |
queueDeclareNoWait(String queue,
boolean durable,
boolean exclusive,
boolean autoDelete,
Map<String,Object> arguments)
Like
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). |
AMQP.Queue.DeclareOk |
queueDeclarePassive(String queue)
Declare a queue passively; i.e., check if it exists.
|
AMQP.Queue.DeleteOk |
queueDelete(String queue)
Delete a queue, without regard for whether it is in use or has messages on it
|
AMQP.Queue.DeleteOk |
queueDelete(String queue,
boolean ifUnused,
boolean ifEmpty)
Delete a queue
|
void |
queueDeleteNoWait(String queue,
boolean ifUnused,
boolean ifEmpty)
Like
queueDelete(String, boolean, boolean) but sets nowait parameter
to true and returns nothing (as there will be no response from the server). |
AMQP.Queue.PurgeOk |
queuePurge(String queue)
Purges the contents of the given queue.
|
AMQP.Queue.UnbindOk |
queueUnbind(String queue,
String exchange,
String routingKey)
Unbinds a queue from an exchange, with no extra arguments.
|
AMQP.Queue.UnbindOk |
queueUnbind(String queue,
String exchange,
String routingKey,
Map<String,Object> arguments)
Unbind a queue from an exchange.
|
boolean |
removeConfirmListener(ConfirmListener listener)
Remove a
ConfirmListener . |
boolean |
removeReturnListener(ReturnListener listener)
Remove a
ReturnListener . |
Command |
rpc(Method method)
Synchronously send a method over this channel.
|
void |
setDefaultConsumer(Consumer consumer)
Set the current default consumer.
|
AMQP.Tx.CommitOk |
txCommit()
Commits a TX transaction on this channel.
|
AMQP.Tx.RollbackOk |
txRollback()
Rolls back a TX transaction on this channel.
|
AMQP.Tx.SelectOk |
txSelect()
Enables TX mode on this channel.
|
boolean |
waitForConfirms()
Wait until all messages published since the last call have been
either ack'd or nack'd by the broker.
|
boolean |
waitForConfirms(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.
|
void |
waitForConfirmsOrDie()
Wait until all messages published since the last call have
been either ack'd or nack'd by the broker.
|
void |
waitForConfirmsOrDie(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.
|
addShutdownListener, getCloseReason, isOpen, notifyListeners, removeShutdownListener
int getChannelNumber()
Connection getConnection()
Connection
void close() throws IOException, TimeoutException
AMQP.REPLY_SUCCESS
close code
and message 'OK'.close
in interface AutoCloseable
IOException
- if an error is encounteredTimeoutException
void close(int closeCode, String closeMessage) throws IOException, TimeoutException
closeCode
- the close code (See under "Reply Codes" in the AMQP specification)closeMessage
- a message indicating the reason for closing the connectionIOException
- if an error is encounteredTimeoutException
void abort() throws IOException
AMQP.REPLY_SUCCESS
close 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.IOException
void abort(int closeCode, String closeMessage) throws IOException
IOException
void addReturnListener(ReturnListener listener)
ReturnListener
.listener
- the listener to addReturnListener addReturnListener(ReturnCallback returnCallback)
ReturnListener
.returnCallback
- the callback when the message is returnedReturnListener
,
ReturnCallback
,
Return
boolean removeReturnListener(ReturnListener listener)
ReturnListener
.listener
- the listener to removetrue
if the listener was found and removed,
false
otherwisevoid clearReturnListeners()
ReturnListener
s.void addConfirmListener(ConfirmListener listener)
ConfirmListener
.listener
- the listener to addConfirmListener addConfirmListener(ConfirmCallback ackCallback, ConfirmCallback nackCallback)
ConfirmListener
.ackCallback
- callback on acknackCallback
- call on nack (negative ack)ConfirmListener
,
ConfirmCallback
boolean removeConfirmListener(ConfirmListener listener)
ConfirmListener
.listener
- the listener to removetrue
if the listener was found and removed,
false
otherwisevoid clearConfirmListeners()
ConfirmListener
s.Consumer getDefaultConsumer()
void setDefaultConsumer(Consumer consumer)
consumer
- the consumer to use, or null indicating "don't use one".void basicQos(int prefetchSize, int prefetchCount, boolean global) throws IOException
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).
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 consumerIOException
- if an error is encounteredAMQP.Basic.Qos
void basicQos(int prefetchCount, boolean global) throws IOException
Note the prefetch count must be between 0 and 65535 (unsigned short in AMQP 0-9-1).
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 consumerIOException
- if an error is encounteredbasicQos(int, int, boolean)
void basicQos(int prefetchCount) throws IOException
Note the prefetch count must be between 0 and 65535 (unsigned short in AMQP 0-9-1).
prefetchCount
- maximum number of messages that the server
will deliver, 0 if unlimitedIOException
- if an error is encounteredbasicQos(int, int, boolean)
void basicPublish(String exchange, String routingKey, AMQP.BasicProperties props, byte[] body) throws IOException
Channel#basicPublish
will eventually block if a
resource-driven alarm is in effect.exchange
- the exchange to publish the message toroutingKey
- the routing keyprops
- other properties for the message - routing headers etcbody
- the message bodyIOException
- if an error is encounteredAMQP.Basic.Publish
,
Resource-driven alarmsvoid basicPublish(String exchange, String routingKey, boolean mandatory, AMQP.BasicProperties props, byte[] body) throws IOException
Channel#basicPublish
will eventually block if a
resource-driven alarm is in effect.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 bodyIOException
- if an error is encounteredAMQP.Basic.Publish
,
Resource-driven alarmsvoid basicPublish(String exchange, String routingKey, boolean mandatory, boolean immediate, AMQP.BasicProperties props, byte[] body) throws IOException
Channel#basicPublish
will eventually block if a
resource-driven alarm is in effect.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 bodyIOException
- if an error is encounteredAMQP.Basic.Publish
,
Resource-driven alarmsAMQP.Exchange.DeclareOk exchangeDeclare(String exchange, String type) throws IOException
exchange
- the name of the exchangetype
- the exchange typeIOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
AMQP.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type) throws IOException
exchange
- the name of the exchangetype
- the exchange typeIOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
AMQP.Exchange.DeclareOk exchangeDeclare(String exchange, String type, boolean durable) throws IOException
exchange
- the name of the exchangetype
- the exchange typedurable
- true if we are declaring a durable exchange (the exchange will survive a server restart)IOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
AMQP.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable) throws IOException
exchange
- the name of the exchangetype
- the exchange typedurable
- true if we are declaring a durable exchange (the exchange will survive a server restart)IOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
AMQP.Exchange.DeclareOk exchangeDeclare(String exchange, String type, boolean durable, boolean autoDelete, Map<String,Object> arguments) throws IOException
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 exchangeIOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
AMQP.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, Map<String,Object> arguments) throws IOException
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 exchangeIOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
AMQP.Exchange.DeclareOk exchangeDeclare(String exchange, String type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
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 exchangeIOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
AMQP.Exchange.DeclareOk exchangeDeclare(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
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 exchangeIOException
- if an error is encounteredAMQP.Exchange.Declare
,
AMQP.Exchange.DeclareOk
void exchangeDeclareNoWait(String exchange, String type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
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).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 exchangeIOException
- if an error is encounteredvoid exchangeDeclareNoWait(String exchange, BuiltinExchangeType type, boolean durable, boolean autoDelete, boolean internal, Map<String,Object> arguments) throws IOException
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).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 exchangeIOException
- if an error is encounteredAMQP.Exchange.DeclareOk exchangeDeclarePassive(String name) throws IOException
name
- check the existence of an exchange named thisIOException
- the server will raise a 404 channel exception if the named exchange does not exist.AMQP.Exchange.DeleteOk exchangeDelete(String exchange, boolean ifUnused) throws IOException
exchange
- the name of the exchangeifUnused
- true to indicate that the exchange is only to be deleted if it is unusedIOException
- if an error is encounteredAMQP.Exchange.Delete
,
AMQP.Exchange.DeleteOk
void exchangeDeleteNoWait(String exchange, boolean ifUnused) throws IOException
exchangeDelete(String, boolean)
but sets nowait parameter to true
and returns void (as there will be no response from the server).exchange
- the name of the exchangeifUnused
- true to indicate that the exchange is only to be deleted if it is unusedIOException
- if an error is encounteredAMQP.Exchange.Delete
,
AMQP.Exchange.DeleteOk
AMQP.Exchange.DeleteOk exchangeDelete(String exchange) throws IOException
exchange
- the name of the exchangeIOException
- if an error is encounteredAMQP.Exchange.Delete
,
AMQP.Exchange.DeleteOk
AMQP.Exchange.BindOk exchangeBind(String destination, String source, String routingKey) throws IOException
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 bindingIOException
- if an error is encounteredAMQP.Exchange.Bind
,
AMQP.Exchange.BindOk
AMQP.Exchange.BindOk exchangeBind(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
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)IOException
- if an error is encounteredAMQP.Exchange.Bind
,
AMQP.Exchange.BindOk
void exchangeBindNoWait(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
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).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)IOException
- if an error is encounteredAMQP.Exchange.UnbindOk exchangeUnbind(String destination, String source, String routingKey) throws IOException
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 bindingIOException
- if an error is encounteredAMQP.Exchange.Bind
,
AMQP.Exchange.BindOk
AMQP.Exchange.UnbindOk exchangeUnbind(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
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)IOException
- if an error is encounteredAMQP.Exchange.Bind
,
AMQP.Exchange.BindOk
void exchangeUnbindNoWait(String destination, String source, String routingKey, Map<String,Object> arguments) throws IOException
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).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)IOException
- if an error is encounteredAMQP.Queue.DeclareOk queueDeclare() throws IOException
AMQP.Queue.DeclareOk
result.IOException
- if an error is encounteredAMQP.Queue.Declare
,
AMQP.Queue.DeclareOk
AMQP.Queue.DeclareOk queueDeclare(String queue, boolean durable, boolean exclusive, boolean autoDelete, Map<String,Object> arguments) throws IOException
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 queueIOException
- if an error is encounteredAMQP.Queue.Declare
,
AMQP.Queue.DeclareOk
void queueDeclareNoWait(String queue, boolean durable, boolean exclusive, boolean autoDelete, Map<String,Object> arguments) throws IOException
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).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 queueIOException
- if an error is encounteredAMQP.Queue.DeclareOk queueDeclarePassive(String queue) throws IOException
queue
- the name of the queueIOException
- if an error is encountered,
including if the queue does not exist and if the queue is
exclusively owned by another connection.AMQP.Queue.Declare
,
AMQP.Queue.DeclareOk
AMQP.Queue.DeleteOk queueDelete(String queue) throws IOException
queue
- the name of the queueIOException
- if an error is encounteredAMQP.Queue.Delete
,
AMQP.Queue.DeleteOk
AMQP.Queue.DeleteOk queueDelete(String queue, boolean ifUnused, boolean ifEmpty) throws IOException
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 emptyIOException
- if an error is encounteredAMQP.Queue.Delete
,
AMQP.Queue.DeleteOk
void queueDeleteNoWait(String queue, boolean ifUnused, boolean ifEmpty) throws IOException
queueDelete(String, boolean, boolean)
but sets nowait parameter
to true and returns nothing (as there will be no response from the server).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 emptyIOException
- if an error is encounteredAMQP.Queue.Delete
,
AMQP.Queue.DeleteOk
AMQP.Queue.BindOk queueBind(String queue, String exchange, String routingKey) throws IOException
queue
- the name of the queueexchange
- the name of the exchangeroutingKey
- the routing key to use for the bindingIOException
- if an error is encounteredAMQP.Queue.Bind
,
AMQP.Queue.BindOk
AMQP.Queue.BindOk queueBind(String queue, String exchange, String routingKey, Map<String,Object> arguments) throws IOException
queue
- the name of the queueexchange
- the name of the exchangeroutingKey
- the routing key to use for the bindingarguments
- other properties (binding parameters)IOException
- if an error is encounteredAMQP.Queue.Bind
,
AMQP.Queue.BindOk
void queueBindNoWait(String queue, String exchange, String routingKey, Map<String,Object> arguments) throws IOException
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).queue
- the name of the queueexchange
- the name of the exchangeroutingKey
- the routing key to use for the bindingarguments
- other properties (binding parameters)IOException
- if an error is encounteredAMQP.Queue.UnbindOk queueUnbind(String queue, String exchange, String routingKey) throws IOException
queue
- the name of the queueexchange
- the name of the exchangeroutingKey
- the routing key to use for the bindingIOException
- if an error is encounteredAMQP.Queue.Unbind
,
AMQP.Queue.UnbindOk
AMQP.Queue.UnbindOk queueUnbind(String queue, String exchange, String routingKey, Map<String,Object> arguments) throws IOException
queue
- the name of the queueexchange
- the name of the exchangeroutingKey
- the routing key to use for the bindingarguments
- other properties (binding parameters)IOException
- if an error is encounteredAMQP.Queue.Unbind
,
AMQP.Queue.UnbindOk
AMQP.Queue.PurgeOk queuePurge(String queue) throws IOException
queue
- the name of the queueIOException
- if an error is encounteredAMQP.Queue.Purge
,
AMQP.Queue.PurgeOk
GetResponse basicGet(String queue, boolean autoAck) throws IOException
AMQP.Basic.Get
queue
- the name of the queueautoAck
- true if the server should consider messages
acknowledged once delivered; false if the server should expect
explicit acknowledgementsGetResponse
containing the retrieved message dataIOException
- if an error is encounteredAMQP.Basic.Get
,
AMQP.Basic.GetOk
,
AMQP.Basic.GetEmpty
void basicAck(long deliveryTag, boolean multiple) throws IOException
AMQP.Basic.GetOk
or AMQP.Basic.Deliver
method
containing the received message being acknowledged.deliveryTag
- the tag from the received AMQP.Basic.GetOk
or AMQP.Basic.Deliver
multiple
- true to acknowledge all messages up to and
including the supplied delivery tag; false to acknowledge just
the supplied delivery tag.IOException
- if an error is encounteredAMQP.Basic.Ack
void basicNack(long deliveryTag, boolean multiple, boolean requeue) throws IOException
deliveryTag
from the AMQP.Basic.GetOk
or AMQP.Basic.Deliver
method containing the message to be rejected.deliveryTag
- the tag from the received AMQP.Basic.GetOk
or AMQP.Basic.Deliver
multiple
- 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-letteredIOException
- if an error is encounteredAMQP.Basic.Nack
void basicReject(long deliveryTag, boolean requeue) throws IOException
AMQP.Basic.GetOk
or AMQP.Basic.Deliver
method
containing the received message being rejected.deliveryTag
- the tag from the received AMQP.Basic.GetOk
or AMQP.Basic.Deliver
requeue
- true if the rejected message should be requeued rather than discarded/dead-letteredIOException
- if an error is encounteredAMQP.Basic.Reject
String basicConsume(String queue, Consumer callback) throws IOException
queue
- the name of the queuecallback
- an interface to the consumer objectIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, DeliverCallback deliverCallback, CancelCallback cancelCallback) throws IOException
basic.deliver
and
basic.cancel
AMQP methods (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.queue
- the name of the queuedeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, DeliverCallback deliverCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
and
shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.queue
- the name of the queuedeliverCallback
- callback when a message is deliveredshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, DeliverCallback deliverCallback, CancelCallback cancelCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
, basic.cancel
and shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.queue
- the name of the queuedeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, Consumer callback) throws IOException
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 objectIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, DeliverCallback deliverCallback, CancelCallback cancelCallback) throws IOException
basic.deliver
and
basic.cancel
AMQP methods (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.queue
- the name of the queueautoAck
- true if the server should consider messages
acknowledged once delivered; false if the server should expect
explicit acknowledgementsdeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, DeliverCallback deliverCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
and
shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.queue
- the name of the queueautoAck
- true if the server should consider messages
acknowledged once delivered; false if the server should expect
explicit acknowledgementsdeliverCallback
- callback when a message is deliveredshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, DeliverCallback deliverCallback, CancelCallback cancelCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
, basic.cancel
and shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.queue
- the name of the queueautoAck
- true if the server should consider messages
acknowledged once delivered; false if the server should expect
explicit acknowledgementsdeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, Map<String,Object> arguments, Consumer callback) throws IOException
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 objectIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, Map<String,Object> arguments, DeliverCallback deliverCallback, CancelCallback cancelCallback) throws IOException
basic.deliver
and
basic.cancel
AMQP methods (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 consumedeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, Map<String,Object> arguments, DeliverCallback deliverCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
and
shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 consumedeliverCallback
- callback when a message is deliveredshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, Map<String,Object> arguments, DeliverCallback deliverCallback, CancelCallback cancelCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
, basic.cancel
and shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 consumedeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicAck(long, boolean)
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, String consumerTag, Consumer callback) throws IOException
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 objectIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, String consumerTag, DeliverCallback deliverCallback, CancelCallback cancelCallback) throws IOException
basic.deliver
and
basic.cancel
AMQP methods (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 contextdeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, String consumerTag, DeliverCallback deliverCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
and
shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 contextdeliverCallback
- callback when a message is deliveredshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, String consumerTag, DeliverCallback deliverCallback, CancelCallback cancelCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
basic.deliver
, basic.cancel
and shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 contextdeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
,
basicConsume(String, boolean, String, boolean, boolean, Map, Consumer)
String basicConsume(String queue, boolean autoAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String,Object> arguments, Consumer callback) throws IOException
Consumer.handleConsumeOk(java.lang.String)
method.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 connection. Note that the RabbitMQ server does not support this flag.exclusive
- true if this is an exclusive consumercallback
- an interface to the consumer objectarguments
- a set of arguments for the consumeIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
String basicConsume(String queue, boolean autoAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String,Object> arguments, DeliverCallback deliverCallback, CancelCallback cancelCallback) throws IOException
Consumer.handleConsumeOk(java.lang.String)
method.
Provide access only to basic.deliver
and
basic.cancel
AMQP methods (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 connection. Note that the RabbitMQ server does not support this flag.exclusive
- true if this is an exclusive consumerarguments
- a set of arguments for the consumedeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
String basicConsume(String queue, boolean autoAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String,Object> arguments, DeliverCallback deliverCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
Consumer.handleConsumeOk(java.lang.String)
method.
Provide access only to basic.deliver
and
shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 connection. Note that the RabbitMQ server does not support this flag.exclusive
- true if this is an exclusive consumerarguments
- a set of arguments for the consumedeliverCallback
- callback when a message is deliveredshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
String basicConsume(String queue, boolean autoAck, String consumerTag, boolean noLocal, boolean exclusive, Map<String,Object> arguments, DeliverCallback deliverCallback, CancelCallback cancelCallback, ConsumerShutdownSignalCallback shutdownSignalCallback) throws IOException
Consumer.handleConsumeOk(java.lang.String)
method.
Provide access to basic.deliver
, basic.cancel
and shutdown signal callbacks (which is sufficient
for most cases). See methods with a Consumer
argument
to have access to all the application callbacks.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 connection. Note that the RabbitMQ server does not support this flag.exclusive
- true if this is an exclusive consumerarguments
- a set of arguments for the consumedeliverCallback
- callback when a message is deliveredcancelCallback
- callback when the consumer is cancelledshutdownSignalCallback
- callback when the channel/connection is shut downIOException
- if an error is encounteredAMQP.Basic.Consume
,
AMQP.Basic.ConsumeOk
void basicCancel(String consumerTag) throws IOException
Consumer.handleCancelOk(java.lang.String)
method.consumerTag
- a client- or server-generated consumer tag to establish contextIOException
- if an error is encountered, or if the consumerTag is unknownAMQP.Basic.Cancel
,
AMQP.Basic.CancelOk
AMQP.Basic.RecoverOk basicRecover() throws IOException
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.IOException
basicRecover(boolean)
AMQP.Basic.RecoverOk basicRecover(boolean requeue) throws IOException
requeue
- If true, messages will be requeued and possibly
delivered to a different consumer. If false, messages will be
redelivered to the same consumer.IOException
AMQP.Tx.SelectOk txSelect() throws IOException
IOException
- if an error is encounteredAMQP.Tx.Select
,
AMQP.Tx.SelectOk
AMQP.Tx.CommitOk txCommit() throws IOException
IOException
- if an error is encounteredAMQP.Tx.Commit
,
AMQP.Tx.CommitOk
AMQP.Tx.RollbackOk txRollback() throws IOException
IOException
- if an error is encounteredAMQP.Tx.Rollback
,
AMQP.Tx.RollbackOk
AMQP.Confirm.SelectOk confirmSelect() throws IOException
IOException
- if an error is encounteredAMQP.Confirm.Select
long getNextPublishSeqNo()
boolean waitForConfirms() throws InterruptedException
IllegalStateException
InterruptedException
boolean waitForConfirms(long timeout) throws InterruptedException, TimeoutException
IllegalStateException
InterruptedException
TimeoutException
void waitForConfirmsOrDie() throws IOException, InterruptedException
void waitForConfirmsOrDie(long timeout) throws IOException, InterruptedException, TimeoutException
void asyncRpc(Method method) throws IOException
method
- method to transmit over this channel.IOException
- Problem transmitting method.Command rpc(Method method) throws IOException
method
- method to transmit over this channel.IOException
- Problem transmitting method.long messageCount(String queue) throws IOException
queue
- the name of the queueIOException
- Problem transmitting method.long consumerCount(String queue) throws IOException
queue
- the name of the queueIOException
- Problem transmitting method.CompletableFuture<Command> asyncCompletableRpc(Method method) throws IOException
method
- method to transmit over this channel.IOException
- Problem transmitting method.Copyright © 2024 Broadcom Inc. and its subsidiaries.. All rights reserved.