io.vertx.core.eventbus.impl

Class EventBusImpl

java.lang.Object

io.vertx.core.eventbus.impl.EventBusImpl

All Implemented Interfaces:

EventBus, Measured, MetricsProvider

public class EventBusImpl
extends Object
implements EventBus, MetricsProvider

This class is thread-safe

Author:

Tim Fox T

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventBusImpl.EventBusNetServer
class	EventBusImpl.HandlerRegistration<T>

Constructor Summary

Constructors

Constructor and Description
EventBusImpl(VertxInternal vertx)
EventBusImpl(VertxInternal vertx, long pingInterval, long pingReplyInterval, ClusterManager clusterManager, HAManager haManager, AsyncMultiMap<String,ServerID> subs, ServerID serverID, EventBusImpl.EventBusNetServer server)

Method Summary

Modifier and Type	Method and Description
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.
protected void	finalize()
EventBusMetrics<?>	getMetrics() Returns the metrics implementation.
boolean	isMetricsEnabled() Whether the metrics are enabled for this measured object
<T> MessageConsumer<T>	localConsumer(String address) Like EventBus.consumer(String) but the address won't be propagated across the cluster.
<T> MessageConsumer<T>	localConsumer(String address, Handler<Message<T>> handler) Like EventBus.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 EventBus.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 EventBus.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.
EventBus	send(String address, Object message) Sends a message.
<T> EventBus	send(String address, Object message, DeliveryOptions options) Like EventBus.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) Like EventBus.send(String, Object, DeliveryOptions) but specifying a replyHandler that will be called if the recipient subsequently replies to the message.
<T> EventBus	send(String address, Object message, Handler<AsyncResult<Message<T>>> replyHandler) Like EventBus.send(String, Object) but specifying a replyHandler that will be called if the recipient subsequently replies to the message.
<T> MessageProducer<T>	sender(String address) Create a message sender against the specified address.
<T> MessageProducer<T>	sender(String address, DeliveryOptions options) Like EventBus.sender(String) but specifying delivery options that will be used for configuring the delivery of the message.
EventBus	unregisterCodec(String name) Unregister a message codec.
EventBus	unregisterDefaultCodec(Class clazz) Unregister a default message codec.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventBusImpl

public EventBusImpl(VertxInternal vertx)

EventBusImpl

public EventBusImpl(VertxInternal vertx,
                    long pingInterval,
                    long pingReplyInterval,
                    ClusterManager clusterManager,
                    HAManager haManager,
                    AsyncMultiMap<String,ServerID> subs,
                    ServerID serverID,
                    EventBusImpl.EventBusNetServer server)

Method Detail

send

public EventBus send(String address,
                     Object message)

Description copied from interface: EventBus

Sends a message.

The message will be delivered to at most one of the handlers registered to the address.

Specified by:

send in interface EventBus

Parameters:

address - the address to send it to

message - the message, may be null

Returns:

a reference to this, so the API can be used fluently

send

public <T> EventBus send(String address,
                         Object message,
                         Handler<AsyncResult<Message<T>>> replyHandler)

Description copied from interface: EventBus

Like EventBus.send(String, Object) but specifying a replyHandler that will be called if the recipient subsequently replies to the message.

Specified by:

send in interface EventBus

Parameters:

address - the address to send it to

message - the message, may be null

replyHandler - reply handler will be called when any reply from the recipient is received, may be null

Returns:

a reference to this, so the API can be used fluently

send

public <T> EventBus send(String address,
                         Object message,
                         DeliveryOptions options)

Description copied from interface: EventBus

Like EventBus.send(String, Object) but specifying options that can be used to configure the delivery.

Specified by:

send in interface EventBus

Parameters:

address - the address to send it to

message - the message, may be null

options - delivery options

Returns:

a reference to this, so the API can be used fluently

send

public <T> EventBus send(String address,
                         Object message,
                         DeliveryOptions options,
                         Handler<AsyncResult<Message<T>>> replyHandler)

Description copied from interface: EventBus

Like EventBus.send(String, Object, DeliveryOptions) but specifying a replyHandler that will be called if the recipient subsequently replies to the message.

Specified by:

send in interface EventBus

Parameters:

address - the address to send it to

message - the message, may be null

options - delivery options

replyHandler - reply handler will be called when any reply from the recipient is received, may be null

Returns:

a reference to this, so the API can be used fluently

sender

public <T> MessageProducer<T> sender(String address)

Description copied from interface: EventBus

Create a message sender against the specified address.

The returned sender will invoke the EventBus.send(String, Object) method when the stream WriteStream.write(Object) method is called with the sender address and the provided data.

Specified by:

sender in interface EventBus

Parameters:

address - the address to send it to

Returns:

The sender

sender

public <T> MessageProducer<T> sender(String address,
                                     DeliveryOptions options)

Description copied from interface: EventBus

Like EventBus.sender(String) but specifying delivery options that will be used for configuring the delivery of the message.

Specified by:

sender in interface EventBus

Parameters:

address - the address to send it to

options - the delivery options

Returns:

The sender

publisher

public <T> MessageProducer<T> publisher(String address)

Description copied from interface: EventBus

Create a message publisher against the specified address.

The returned publisher will invoke the EventBus.publish(String, Object) method when the stream WriteStream.write(Object) method is called with the publisher address and the provided data.

Specified by:

publisher in interface EventBus

Parameters:

address - The address to publish it to

Returns:

The publisher

publisher

public <T> MessageProducer<T> publisher(String address,
                                        DeliveryOptions options)

Description copied from interface: EventBus

Like EventBus.publisher(String) but specifying delivery options that will be used for configuring the delivery of the message.

Specified by:

publisher in interface EventBus

Parameters:

address - the address to publish it to

options - the delivery options

Returns:

The publisher

publish

public EventBus publish(String address,
                        Object message)

Description copied from interface: EventBus

Publish a message.

The message will be delivered to all handlers registered to the address.

Specified by:

publish in interface EventBus

Parameters:

address - the address to publish it to

message - the message, may be null

Returns:

a reference to this, so the API can be used fluently

publish

public EventBus publish(String address,
                        Object message,
                        DeliveryOptions options)

Description copied from interface: EventBus

Like EventBus.publish(String, Object) but specifying options that can be used to configure the delivery.

Specified by:

publish in interface EventBus

Parameters:

address - the address to publish it to

message - the message, may be null

options - the delivery options

Returns:

a reference to this, so the API can be used fluently

consumer

public <T> MessageConsumer<T> consumer(String address)

Description copied from interface: EventBus

Create a message consumer against the specified address.

The returned consumer is not yet registered at the address, registration will be effective when MessageConsumer.handler(io.vertx.core.Handler) is called.

Specified by:

consumer in interface EventBus

Parameters:

address - the address that it will register it at

Returns:

the event bus message consumer

consumer

public <T> MessageConsumer<T> consumer(String address,
                                       Handler<Message<T>> handler)

Description copied from interface: EventBus

Create a consumer and register it against the specified address.

Specified by:

consumer in interface EventBus

Parameters:

address - the address that will register it at

handler - the handler that will process the received messages

Returns:

the event bus message consumer

localConsumer

public <T> MessageConsumer<T> localConsumer(String address)

Description copied from interface: EventBus

Like EventBus.consumer(String) but the address won't be propagated across the cluster.

Specified by:

localConsumer in interface EventBus

Parameters:

address - the address to register it at

Returns:

the event bus message consumer

localConsumer

public <T> MessageConsumer<T> localConsumer(String address,
                                            Handler<Message<T>> handler)

Description copied from interface: EventBus

Like EventBus.consumer(String, Handler) but the address won't be propagated across the cluster.

Specified by:

localConsumer in interface EventBus

Parameters:

address - the address that will register it at

handler - the handler that will process the received messages

Returns:

the event bus message consumer

registerCodec

public EventBus registerCodec(MessageCodec codec)

Description copied from interface: EventBus

Register a message 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.

Specified by:

registerCodec in interface EventBus

Parameters:

codec - the message codec to register

Returns:

a reference to this, so the API can be used fluently

unregisterCodec

public EventBus unregisterCodec(String name)

Description copied from interface: EventBus

Unregister a message codec.

Specified by:

unregisterCodec in interface EventBus

Parameters:

name - the name of the codec

Returns:

a reference to this, so the API can be used fluently

registerDefaultCodec

public <T> EventBus registerDefaultCodec(Class<T> clazz,
                                         MessageCodec<T,?> codec)

Description copied from interface: EventBus

Register a default message 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.

Specified by:

registerDefaultCodec in interface EventBus

Parameters:

clazz - the class for which to use this codec

codec - the message codec to register

Returns:

a reference to this, so the API can be used fluently

unregisterDefaultCodec

public EventBus unregisterDefaultCodec(Class clazz)

Description copied from interface: EventBus

Unregister a default message codec.

Specified by:

unregisterDefaultCodec in interface EventBus

Parameters:

clazz - the class for which the codec was registered

Returns:

@return a reference to this, so the API can be used fluently

close

public void close(Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: EventBus

Close the event bus and release any resources held

Specified by:

close in interface EventBus

Parameters:

completionHandler - may be null

isMetricsEnabled

public boolean isMetricsEnabled()

Description copied from interface: Measured

Whether the metrics are enabled for this measured object

Specified by:

isMetricsEnabled in interface Measured

Returns:

true if the metrics are enabled

getMetrics

public EventBusMetrics<?> getMetrics()

Description copied from interface: MetricsProvider

Returns the metrics implementation.

Specified by:

getMetrics in interface MetricsProvider

Returns:

the metrics

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable