io.micronaut.rabbitmq.annotation

Annotation Type Queue

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Executable
 @Inherited
public @interface Queue

Used to specify which queue messages should be consumed from. The queue must already exist in the broker.

Since:

1.1.0

Author:

James Kleeh

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoAcknowledgment
String	connection
boolean	exclusive
String	executor
int	numberOfConsumers
String	numberOfConsumersValue
int	prefetch
boolean	reQueue Only applies to consumer methods that do not inject an Acknowledgement instance.

Element Detail

value

@AliasFor(annotation=io.micronaut.messaging.annotation.MessageMapping.class,
          member="value")
public abstract String value

Returns:

The queue to subscribe to.

reQueue

public abstract boolean reQueue

Only applies to consumer methods that do not inject an Acknowledgement instance.

Returns:

Whether nacks should re-queue the message.

Default:

false

exclusive

public abstract boolean exclusive

Returns:

Whether the consumer is exclusive to the queue

Default:

false

autoAcknowledgment

public abstract boolean autoAcknowledgment

Returns:

Whether the consumer should consider messages acknowledged once delivered

Since:

3.4.0

Default:

false

prefetch

public abstract int prefetch

Returns:

The unacknowledged message limit

Default:

0

numberOfConsumers

public abstract int numberOfConsumers

Returns:

The number of consumers used to consumer from a queue concurrently

Default:

1

numberOfConsumersValue

@AliasFor(member="numberOfConsumers")
public abstract String numberOfConsumersValue

Returns:

The number of consumers used to consumer from a queue concurrently. Allows for the configuration property placeholders.

Since:

3.4.0

Default:

"1"

connection

@AliasFor(annotation=RabbitConnection.class,
          member="connection")
public abstract String connection

Returns:

The connection to use

See Also:

RabbitConnection.connection()

Default:

""

executor

@AliasFor(annotation=RabbitConnection.class,
          member="executor")
public abstract String executor

Returns:

The executor to use

See Also:

RabbitConnection.executor()

Default:

""