io.micronaut.context.event

Interface ApplicationEventPublisher<T>

Type Parameters:

T - The event type

All Known Subinterfaces:

ApplicationContext, BeanContext, InitializableBeanContext

All Known Implementing Classes:

DefaultApplicationContext, DefaultBeanContext

public interface ApplicationEventPublisher<T>

Interface for classes that publish events received by ApplicationEventListener instances.

Note that this interface is designed for application level, non-blocking synchronous events for decoupling code and is not a replacement for a messaging system

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static ApplicationEventPublisher<?>	NO_OP

Method Summary

Modifier and Type	Method and Description
static <K> ApplicationEventPublisher<K>	noOp() Returns a no-op instance of ApplicationEventPublisher.
void	publishEvent(T event) Publish the given event.
default Future<Void>	publishEventAsync(T event) Publish the given event.

Field Detail

NO_OP

static final ApplicationEventPublisher<?> NO_OP

Method Detail

noOp

static <K> ApplicationEventPublisher<K> noOp()

Returns a no-op instance of ApplicationEventPublisher.

Type Parameters:

K - The event type

Returns:

an instance of ApplicationEventPublisher

publishEvent

void publishEvent(@NonNull
                  T event)

Publish the given event. The event will be published synchronously and only return once all listeners have consumed the event.

Parameters:

event - The event to publish

publishEventAsync

@NonNull
default Future<Void> publishEventAsync(@NonNull
                                                T event)

Publish the given event. The event will be published asynchronously. A future is returned that can be used to check whether the event completed successfully or not.

Parameters:

event - The event to publish

Returns:

A future that completes when the event is published

Since:

1.3.5