public interface EventBus extends Measured
An event-bus supports publish-subscribe messaging, point-to-point messaging and request-response messaging.
Message delivery is best-effort and messages can be lost if failure of all or part of the event bus occurs.
Please refer to the documentation for more information on the event bus.
Modifier and Type | Method and Description |
---|---|
<T> EventBus |
addInboundInterceptor(Handler<DeliveryContext<T>> interceptor)
Add an interceptor that will be called whenever a message is received by Vert.x
|
<T> EventBus |
addOutboundInterceptor(Handler<DeliveryContext<T>> interceptor)
Add an interceptor that will be called whenever a message is sent from Vert.x
|
void |
close(Handler<AsyncResult<Void>> completionHandler)
Close the event bus and release any resources held.
|
<T> MessageConsumer<T> |
consumer(String address)
Create a message consumer against the specified address.
|
<T> MessageConsumer<T> |
consumer(String address,
Handler<Message<T>> handler)
Create a consumer and register it against the specified address.
|
<T> MessageConsumer<T> |
localConsumer(String address)
Like
consumer(String) but the address won't be propagated across the cluster. |
<T> MessageConsumer<T> |
localConsumer(String address,
Handler<Message<T>> handler)
Like
consumer(String, Handler) but the address won't be propagated across the cluster. |
EventBus |
publish(String address,
Object message)
Publish a message.
|
EventBus |
publish(String address,
Object message,
DeliveryOptions options)
Like
publish(String, Object) but specifying options that can be used to configure the delivery. |
<T> MessageProducer<T> |
publisher(String address)
Create a message publisher against the specified address.
|
<T> MessageProducer<T> |
publisher(String address,
DeliveryOptions options)
Like
publisher(String) but specifying delivery options that will be used for configuring the delivery of
the message. |
EventBus |
registerCodec(MessageCodec codec)
Register a message codec.
|
<T> EventBus |
registerDefaultCodec(Class<T> clazz,
MessageCodec<T,?> codec)
Register a default message codec.
|
<T> EventBus |
removeInboundInterceptor(Handler<DeliveryContext<T>> interceptor)
Remove an interceptor that was added by
addInboundInterceptor(Handler) |
<T> EventBus |
removeOutboundInterceptor(Handler<DeliveryContext<T>> interceptor)
Remove an interceptor that was added by
addOutboundInterceptor(Handler) |
default <T> EventBus |
request(String address,
Object message,
DeliveryOptions options,
Handler<AsyncResult<Message<T>>> replyHandler)
Like
request(String, Object, Handler) but specifying options that can be used to configure the delivery. |
default <T> EventBus |
request(String address,
Object message,
Handler<AsyncResult<Message<T>>> replyHandler)
Sends a message and and specify a
replyHandler that will be called if the recipient
subsequently replies to the message. |
EventBus |
send(String address,
Object message)
Sends a message.
|
EventBus |
send(String address,
Object message,
DeliveryOptions options)
Like
send(String, Object) but specifying options that can be used to configure the delivery. |
<T> EventBus |
send(String address,
Object message,
DeliveryOptions options,
Handler<AsyncResult<Message<T>>> replyHandler)
Deprecated.
|
<T> EventBus |
send(String address,
Object message,
Handler<AsyncResult<Message<T>>> replyHandler)
Deprecated.
use
request(String, Object, Handler) instead |
<T> MessageProducer<T> |
sender(String address)
Create a message sender against the specified address.
|
<T> MessageProducer<T> |
sender(String address,
DeliveryOptions options)
Like
sender(String) but specifying delivery options that will be used for configuring the delivery of
the message. |
void |
start(Handler<AsyncResult<Void>> completionHandler)
Start the event bus.
|
EventBus |
unregisterCodec(String name)
Unregister a message codec.
|
EventBus |
unregisterDefaultCodec(Class clazz)
Unregister a default message codec.
|
isMetricsEnabled
EventBus send(String address, Object message)
The message will be delivered to at most one of the handlers registered to the address.
address
- the address to send it tomessage
- the message, may be null
@Deprecated <T> EventBus send(String address, Object message, Handler<AsyncResult<Message<T>>> replyHandler)
request(String, Object, Handler)
insteadsend(String, Object)
but specifying a replyHandler
that will be called if the recipient
subsequently replies to the message.address
- the address to send it tomessage
- the message, may be null
replyHandler
- reply handler will be called when any reply from the recipient is received, may be null
EventBus send(String address, Object message, DeliveryOptions options)
send(String, Object)
but specifying options
that can be used to configure the delivery.address
- the address to send it tomessage
- the message, may be null
options
- delivery options@Deprecated <T> EventBus send(String address, Object message, DeliveryOptions options, Handler<AsyncResult<Message<T>>> replyHandler)
request(String, Object, DeliveryOptions, Handler)
insteadsend(String, Object, DeliveryOptions)
but specifying a replyHandler
that will be called if the recipient
subsequently replies to the message.address
- the address to send it tomessage
- the message, may be null
options
- delivery optionsreplyHandler
- reply handler will be called when any reply from the recipient is received, may be null
default <T> EventBus request(String address, Object message, Handler<AsyncResult<Message<T>>> replyHandler)
replyHandler
that will be called if the recipient
subsequently replies to the message.
The message will be delivered to at most one of the handlers registered to the address.
address
- the address to send it tomessage
- the message body, may be null
replyHandler
- reply handler will be called when any reply from the recipient is receiveddefault <T> EventBus request(String address, Object message, DeliveryOptions options, Handler<AsyncResult<Message<T>>> replyHandler)
request(String, Object, Handler)
but specifying options
that can be used to configure the delivery.address
- the address to send it tomessage
- the message body, may be null
options
- delivery optionsreplyHandler
- reply handler will be called when any reply from the recipient is receivedEventBus publish(String address, Object message)
The message will be delivered to all handlers registered to the address.
address
- the address to publish it tomessage
- the message, may be null
EventBus publish(String address, Object message, DeliveryOptions options)
publish(String, Object)
but specifying options
that can be used to configure the delivery.address
- the address to publish it tomessage
- the message, may be null
options
- the delivery options<T> MessageConsumer<T> consumer(String address)
The returned consumer is not yet registered
at the address, registration will be effective when MessageConsumer.handler(io.vertx.core.Handler)
is called.
address
- the address that it will register it at<T> MessageConsumer<T> consumer(String address, Handler<Message<T>> handler)
address
- the address that will register it athandler
- the handler that will process the received messages<T> MessageConsumer<T> localConsumer(String address)
consumer(String)
but the address won't be propagated across the cluster.address
- the address to register it at<T> MessageConsumer<T> localConsumer(String address, Handler<Message<T>> handler)
consumer(String, Handler)
but the address won't be propagated across the cluster.address
- the address that will register it athandler
- the handler that will process the received messages<T> MessageProducer<T> sender(String address)
The returned sender will invoke the send(String, Object)
method when the stream WriteStream.write(Object)
method is called with the sender
address and the provided data.
address
- the address to send it to<T> MessageProducer<T> sender(String address, DeliveryOptions options)
sender(String)
but specifying delivery options that will be used for configuring the delivery of
the message.address
- the address to send it tooptions
- the delivery options<T> MessageProducer<T> publisher(String address)
The returned publisher will invoke the publish(String, Object)
method when the stream WriteStream.write(Object)
method is called with the publisher
address and the provided data.
address
- The address to publish it to<T> MessageProducer<T> publisher(String address, DeliveryOptions options)
publisher(String)
but specifying delivery options that will be used for configuring the delivery of
the message.address
- the address to publish it tooptions
- the delivery optionsEventBus registerCodec(MessageCodec codec)
You can register a message codec if you want to send any non standard message across the event bus. E.g. you might want to send POJOs directly across the event bus.
To use a message codec for a send, you should specify it in the delivery options.
codec
- the message codec to registerEventBus unregisterCodec(String name)
name
- the name of the codec<T> EventBus registerDefaultCodec(Class<T> clazz, MessageCodec<T,?> codec)
You can register a message codec if you want to send any non standard message across the event bus. E.g. you might want to send POJOs directly across the event bus.
Default message codecs will be used to serialise any messages of the specified type on the event bus without the codec having to be specified in the delivery options.
clazz
- the class for which to use this codeccodec
- the message codec to registerEventBus unregisterDefaultCodec(Class clazz)
clazz
- the class for which the codec was registeredvoid start(Handler<AsyncResult<Void>> completionHandler)
completionHandler
- handler will be called when event bus is startedvoid close(Handler<AsyncResult<Void>> completionHandler)
completionHandler
- may be null
<T> EventBus addOutboundInterceptor(Handler<DeliveryContext<T>> interceptor)
interceptor
- the interceptor<T> EventBus removeOutboundInterceptor(Handler<DeliveryContext<T>> interceptor)
addOutboundInterceptor(Handler)
interceptor
- the interceptor<T> EventBus addInboundInterceptor(Handler<DeliveryContext<T>> interceptor)
interceptor
- the interceptor<T> EventBus removeInboundInterceptor(Handler<DeliveryContext<T>> interceptor)
addInboundInterceptor(Handler)
interceptor
- the interceptorCopyright © 2023 Eclipse. All rights reserved.