io.micronaut.context.event

Interface ApplicationEventPublisher

All Known Subinterfaces:

ApplicationContext, BeanContext

All Known Implementing Classes:

DefaultApplicationContext, DefaultBeanContext

public interface ApplicationEventPublisher

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

Method Summary

Modifier and Type	Method and Description
void	publishEvent(java.lang.Object event) Publish the given event.
default java.util.concurrent.Future<java.lang.Void>	publishEventAsync(java.lang.Object event) Publish the given event.

Method Detail

publishEvent

void publishEvent(@NonNull
                  java.lang.Object 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 java.util.concurrent.Future<java.lang.Void> publishEventAsync(@NonNull
                                                                               java.lang.Object 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