Class AsyncEventBusRegistry<KeyType, EventType extends IAsyncEvent<KeyType>>

java.lang.Object

com.hypixel.hytale.event.EventBusRegistry<KeyType, EventType, com.hypixel.hytale.event.AsyncEventBusRegistry.AsyncEventConsumerMap<EventType>>

com.hypixel.hytale.event.AsyncEventBusRegistry<KeyType, EventType>

Type Parameters:

KeyType - The type of the key used to identify event consumers.

EventType - The type of the asynchronous event.

public class AsyncEventBusRegistry<KeyType, EventType extends IAsyncEvent<KeyType>>
extends EventBusRegistry<KeyType, EventType, com.hypixel.hytale.event.AsyncEventBusRegistry.AsyncEventConsumerMap<EventType>>

An asynchronous event bus registry that allows for the registration and dispatching of asynchronous events.

Nested Class Summary

Nested classes/interfaces inherited from class EventBusRegistry

EventBusRegistry.EventConsumer, EventBusRegistry.EventConsumerMap<EventType, ConsumerType, ReturnType>

Field Summary

Fields

Modifier and Type	Field	Description
static final IEventDispatcher	NO_OP	A no-operation event dispatcher that simply returns the event without any processing.

Constructor Summary

Constructors

Constructor	Description
AsyncEventBusRegistry(HytaleLogger logger, Class<EventType> eventClass)	Default Constructor for a AsyncEventBusRegistry instance.

Method Summary

Modifier and Type	Method	Description
IEventDispatcher<EventType, CompletableFuture<EventType>>	dispatchFor(KeyType key)	Called to get an event dispatcher for the specified key.
EventRegistration<KeyType, EventType>	register(short priority, KeyType key, Consumer<EventType> consumer)	Called to register an event consumer.
EventRegistration<KeyType, EventType>	registerAsync(short priority, KeyType key, Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function)	Called to register an asynchronous event consumer for a specific key.
EventRegistration<KeyType, EventType>	registerAsyncGlobal(short priority, Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function)	Registers a global asynchronous event consumer.
EventRegistration<KeyType, EventType>	registerAsyncUnhandled(short priority, Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function)	Registers an unhandled asynchronous event consumer.
EventRegistration<KeyType, EventType>	registerGlobal(short priority, Consumer<EventType> consumer)	Called to register a global event consumer.
EventRegistration<KeyType, EventType>	registerUnhandled(short priority, Consumer<EventType> consumer)	Called to register an unhandled event consumer.

Methods inherited from class EventBusRegistry

getEventClass, isAlive, isTimeEvents, setTimeEvents, shutdown

Methods inherited from class Object

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

Field Details

NO_OP

@Nonnull
public static final IEventDispatcher NO_OP

A no-operation event dispatcher that simply returns the event without any processing.

Constructor Details

AsyncEventBusRegistry

public AsyncEventBusRegistry(@Nonnull
 HytaleLogger logger,
 @Nonnull
 Class<EventType> eventClass)

Default Constructor for a AsyncEventBusRegistry instance.

Parameters:

logger - The logger to use for logging events.

eventClass - The class of the event type.

Method Details

registerAsync

@Nonnull
public EventRegistration<KeyType, EventType> registerAsync(short priority,
 @Nonnull
 KeyType key,
 @Nonnull
 Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function)

Called to register an asynchronous event consumer for a specific key.

Parameters:

priority - The priority of the event consumer.

key - The key to register the event consumer for.

function - The function that processes the event asynchronously.

Returns:

an EventRegistration representing the registered event consumer.

registerAsyncGlobal

@Nonnull
public EventRegistration<KeyType, EventType> registerAsyncGlobal(short priority,
 @Nonnull
 Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function)

Registers a global asynchronous event consumer.

Parameters:

priority - The priority of the event consumer.

function - The function that processes the event asynchronously.

Returns:

an EventRegistration representing the registered event consumer.

registerAsyncUnhandled

@Nonnull
public EventRegistration<KeyType, EventType> registerAsyncUnhandled(short priority,
 @Nonnull
 Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function)

Registers an unhandled asynchronous event consumer.

Parameters:

priority - The priority of the event consumer.

function - The function that processes the event asynchronously.

Returns:

an EventRegistration representing the registered event consumer.

register

@Nonnull
public EventRegistration<KeyType, EventType> register(short priority,
 KeyType key,
 @Nonnull
 Consumer<EventType> consumer)

Description copied from class: EventBusRegistry

Called to register an event consumer.

Specified by:

register in class EventBusRegistry<KeyType, EventType extends IAsyncEvent<KeyType>, com.hypixel.hytale.event.AsyncEventBusRegistry.AsyncEventConsumerMap<EventType extends IAsyncEvent<KeyType>>>

Parameters:

priority - The priority of the consumer.

key - The key to filter events by.

consumer - The event consumer.

Returns:

the event registration.

registerGlobal

@Nonnull
public EventRegistration<KeyType, EventType> registerGlobal(short priority,
 @Nonnull
 Consumer<EventType> consumer)

Description copied from class: EventBusRegistry

Called to register a global event consumer.

Specified by:

registerGlobal in class EventBusRegistry<KeyType, EventType extends IAsyncEvent<KeyType>, com.hypixel.hytale.event.AsyncEventBusRegistry.AsyncEventConsumerMap<EventType extends IAsyncEvent<KeyType>>>

Parameters:

priority - The priority of the consumer.

consumer - The event consumer.

Returns:

the event registration.

registerUnhandled

@Nonnull
public EventRegistration<KeyType, EventType> registerUnhandled(short priority,
 @Nonnull
 Consumer<EventType> consumer)

Description copied from class: EventBusRegistry

Called to register an unhandled event consumer.

Specified by:

registerUnhandled in class EventBusRegistry<KeyType, EventType extends IAsyncEvent<KeyType>, com.hypixel.hytale.event.AsyncEventBusRegistry.AsyncEventConsumerMap<EventType extends IAsyncEvent<KeyType>>>

Parameters:

priority - The priority of the consumer.

consumer - The event consumer.

Returns:

the event registration.

dispatchFor

@Nonnull
public IEventDispatcher<EventType, CompletableFuture<EventType>> dispatchFor(@Nullable
 KeyType key)

Description copied from class: EventBusRegistry

Called to get an event dispatcher for the specified key.

Specified by:

dispatchFor in class EventBusRegistry<KeyType, EventType extends IAsyncEvent<KeyType>, com.hypixel.hytale.event.AsyncEventBusRegistry.AsyncEventConsumerMap<EventType extends IAsyncEvent<KeyType>>>

Parameters:

key - The key to filter events by.

Returns:

the event dispatcher.