channel-event-bus/com.hoc081098.channeleventbus

Package-level declarations

Types

interface ChannelEvent<T : ChannelEvent<T>>

Represents an event that can be sent to a ChannelEventBus.

ChannelEventBus

sealed interface ChannelEventBus

ChannelEventBusCapacity

enum ChannelEventBusCapacity : Enum<ChannelEventBusCapacity>

The capacity of the Channel associated with a ChannelEvent.Key.

ChannelEventBusException

sealed class ChannelEventBusException : RuntimeException

Represents an exception thrown by ChannelEventBus.

ChannelEventBusLogger

interface ChannelEventBusLogger

Logger for ChannelEventBus. It is used to log events of ChannelEventBus.

ChannelEventKey

typealias ChannelEventKey<T> = ChannelEvent.Key<T>

Alias for ChannelEvent.Key.

OptionWhenSendingToBusDoesNotExist

enum OptionWhenSendingToBusDoesNotExist : Enum<OptionWhenSendingToBusDoesNotExist>

Option when sending an event to a bus that does not exist.

ValidationBeforeClosing

enum ValidationBeforeClosing : Enum<ValidationBeforeClosing>

Options for validating a bus before closing.

Functions

ChannelEventBus

fun ChannelEventBus(logger: ChannelEventBusLogger? = null): ChannelEventBus

Create a new ChannelEventBus instance.

channelEventKeyOf

inline fun <T : ChannelEvent<T>> channelEventKeyOf(capacity: ChannelEventBusCapacity = ChannelEventBusCapacity.UNLIMITED): ChannelEventKey<T>

Retrieve the ChannelEvent.Key for T.