event

Documentation

Overview

Package event provides an event dispatcher for the application.

Index

• type Dispatcher
  • func NewDispatcher() Dispatcher
  • func NewNoOpDispatcher() Dispatcher
• type Event
  • func NewEvent(eventType EventType, payload any) Event
• type EventType
• type Handler
• type NoOpDispatcher
  • func (d *NoOpDispatcher) Dispatch(_ context.Context, _ Event) error
  • func (d *NoOpDispatcher) Subscribe(_ EventType, _ Handler)
  • func (d *NoOpDispatcher) Unsubscribe(_ EventType, _ Handler)

Types

type Dispatcher

type Dispatcher interface {
	// Dispatch sends an event to all registered handlers.
	Dispatch(ctx context.Context, event Event) error

	// Subscribe registers a handler for the given event type.
	Subscribe(eventType EventType, handler Handler)

	// Unsubscribe removes a handler from the given event type.
	Unsubscribe(eventType EventType, handler Handler)
}

Dispatcher dispatches events to registered handlers.

func NewDispatcher

func NewDispatcher() Dispatcher

NewDispatcher creates a new event dispatcher.

func NewNoOpDispatcher

func NewNoOpDispatcher() Dispatcher

NewNoOpDispatcher creates a new no-op dispatcher.

type Event

type Event struct {
	Type      EventType
	Payload   any
	Timestamp time.Time
}

Event represents an application event.

func NewEvent

func NewEvent(eventType EventType, payload any) Event

NewEvent creates a new event with the current timestamp.

type EventType

type EventType string

EventType represents the type of an event.

const (
	EventJobCreated   EventType = "job.created"
	EventJobScheduled EventType = "job.scheduled"
	EventJobStarted   EventType = "job.started"
	EventJobCompleted EventType = "job.completed"
	EventJobFailed    EventType = "job.failed"
	EventJobCancelled EventType = "job.cancelled"
	EventJobRetrying  EventType = "job.retrying"
)

Job lifecycle events.

type Handler

type Handler func(ctx context.Context, event Event) error

Handler is a function that handles an event.

type NoOpDispatcher

type NoOpDispatcher struct{}

NoOpDispatcher is a dispatcher that does nothing. Useful for testing or when events are not needed.

func (*NoOpDispatcher) Dispatch

func (d *NoOpDispatcher) Dispatch(_ context.Context, _ Event) error

Dispatch does nothing.

func (*NoOpDispatcher) Subscribe

func (d *NoOpDispatcher) Subscribe(_ EventType, _ Handler)

Subscribe does nothing.

func (*NoOpDispatcher) Unsubscribe

func (d *NoOpDispatcher) Unsubscribe(_ EventType, _ Handler)

Unsubscribe does nothing.