extension

type AsyncEventBroker ¶

type AsyncEventBroker[E any] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

AsyncEventBroker maintains a list of listeners interested in a specific type of event. Events are sent in parallel to all listeners, and no result is returned.

func (eb *AsyncEventBroker[E]) AddListener(name string, listener func(E))

func (eb *AsyncEventBroker[E]) AsyncTestListener(name string, capacity int) func() (*E, error)

func (eb *AsyncEventBroker[E]) Emit(event *E)

func (eb *AsyncEventBroker[E]) RemoveListener(name string)

type EventBroker ¶

type EventBroker[E any, R interface{}] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

EventBroker maintains a list of listeners interested in a specific type of event.

func (eb *EventBroker[E, R]) AddListener(name string, listener func(E) *R)

func (eb *EventBroker[E, R]) Emit(event *E) *R

func (eb *EventBroker[E, R]) RemoveListener(name string)

type Events ¶

type Events struct {
	AfterMessageDeleted AsyncEventBroker[event.MessageMetadata]
	AfterMessageStored  AsyncEventBroker[event.MessageMetadata]
	BeforeMailAccepted  EventBroker[event.AddressParts, bool]
	BeforeMessageStored EventBroker[event.InboundMessage, event.InboundMessage]
}

Events defines all the event types supported by the extension host.

Before-events provide an opportunity for extensions to alter how Inbucket responds to that type of event. These events are processed synchronously; expensive operations will reduce the perceived performance of Inbucket. The first listener in the list to respond with a non-nil value will determine the response, and the remaining listeners will not be called.

After-events allow extensions to take an action after an event has completed. These events are processed asynchronously with respect to the rest of Inbuckets operation. However, an event listener will not be called until the one before it complets.

type Host ¶

type Host struct {
	Events *Events
}

Host defines extension points for Inbucket.

func NewHost() *Host

type Void ¶

type Void struct{}

Void indicates the event emitter will ignore any value returned by listeners.