io.quarkus.vertx

Annotation Type ConsumeEvent

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ConsumeEvent

Marks a business method to be automatically registered as a Vertx message consumer.

The method must accept exactly one parameter. If it accepts Message then the return type must be void. For any other type the Message.body() is passed as the parameter value and the method may return an object that is passed to Message.reply(Object), either directly or via CompletionStage.thenAccept(java.util.function.Consumer) in case of the method returns a completion stage.

 @ApplicationScoped
 class MyService {

     @ConsumeEvent("echo")
     String echo(String msg) {
         return msg.toUpperCase();
     }
 
     @ConsumeEvent("echoMessage")
     void echoMessage(Message msg) {
         msg.reply(msg.body().toUpperCase());
     }
 
     @ConsumeEvent(value = "echoMessageBlocking", blocking = true)
     void echoMessageBlocking(Message msg) {
         msg.reply(msg.body().toUpperCase());
     }
 }
 

See Also:

EventBus

Field Summary

Fields

Modifier and Type	Fields and Description
static int	FAILURE_CODE Failure code used when a message consumer method throws an exception.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	blocking
boolean	local
String	value The address the consumer will be registered to.

Field Detail

FAILURE_CODE

public static final int FAILURE_CODE

Failure code used when a message consumer method throws an exception.

Element Detail

value

public abstract String value

The address the consumer will be registered to. By default, the fully qualified name of the declaring bean class is assumed.

Returns:

the address

Default:

""

local

public abstract boolean local

Returns:

true if the address should not be propagated across the cluster

See Also:

EventBus.localConsumer(String)

Default:

false

blocking

public abstract boolean blocking

Returns:

true if the consumer should be invoked as a blocking operation using a worker thread

See Also:

Vertx.executeBlocking(io.vertx.core.Handler, boolean, io.vertx.core.Handler)

Default:

false