Documentation
¶
Index ¶
- Variables
- func Dispatch(ev Event)
- func SetDefault(m Mediator)
- func Subscribe(hdl EventHandler)
- type Event
- type EventCollection
- type EventHandler
- type EventKind
- type InMemMediator
- func (m *InMemMediator) Dispatch(ev Event) error
- func (m *InMemMediator) GracefulShutdown(ctx context.Context) error
- func (m *InMemMediator) Subscribe(hdl EventHandler)
- func (m *InMemMediator) WithGenContext(fn func(ctx context.Context, ev Event) context.Context)
- func (m *InMemMediator) WithLogger(logger *slog.Logger)
- func (m *InMemMediator) WithOrphanEventHandler(fn func(Event) error)
- func (m *InMemMediator) WithTimeout(timeout time.Duration)
- type Mediator
- type Options
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrMediatorClosed = errors.New("mediator is closed") ErrNoHandlerMatched = errors.New("no matching event handler found") )
Functions ¶
func SetDefault ¶
func SetDefault(m Mediator)
func Subscribe ¶
func Subscribe(hdl EventHandler)
Types ¶
type EventCollection ¶
func NewEventCollection ¶
func NewEventCollection() EventCollection
type EventHandler ¶
type InMemMediator ¶
type InMemMediator struct {
// contains filtered or unexported fields
}
InMemMediator is a simple in-memory mediator implementation.
func (*InMemMediator) Dispatch ¶
func (m *InMemMediator) Dispatch(ev Event) error
Dispatch dispatches an event to the mediator.
func (*InMemMediator) GracefulShutdown ¶ added in v0.6.3
func (m *InMemMediator) GracefulShutdown(ctx context.Context) error
GracefulShutdown waits for all the events to be processed and then closes the mediator.
func (*InMemMediator) Subscribe ¶
func (m *InMemMediator) Subscribe(hdl EventHandler)
Subscribe registers an event handler to the mediator.
func (*InMemMediator) WithGenContext ¶ added in v0.5.11
WithGenContext present a function to generate a new context for each handler.
func (*InMemMediator) WithLogger ¶ added in v0.6.1
func (m *InMemMediator) WithLogger(logger *slog.Logger)
func (*InMemMediator) WithOrphanEventHandler ¶
func (m *InMemMediator) WithOrphanEventHandler(fn func(Event) error)
WithOrphanEventHandler present a function to handle the event when no handler is found.
func (*InMemMediator) WithTimeout ¶ added in v0.5.11
func (m *InMemMediator) WithTimeout(timeout time.Duration)
WithTimeout present a timeout for each handler.
type Mediator ¶
type Mediator interface {
Dispatch(Event) error
Subscribe(EventHandler)
}
Mediator is the interface that wraps the methods of a mediator.
func NewInMemMediator ¶
Source Files
Click to show internal directories.
Click to hide internal directories.