go_events

README

# go-events A simple library to allow for pub/sub events in golang.

Documentation

Index

• type Event
• type PublishableEvent
• type Publisher
• type SubscribableEvent
• type Subscriber
• type SubscriberHandlerFunc

Types

type Event

type Event interface {
	// Type returns the event type.
	Type() string
}

Event marks items that can be sent as events.

type PublishableEvent

type PublishableEvent interface {
	Event
	// Payload returns the serialized payload for this event.
	Payload() ([]byte, error)
}

type Publisher

type Publisher interface {
	// Write an event to the Publisher. If no error is returned, the caller will
	// assume that all events have been committed to the publisher. If an error is
	// received, the caller may retry sending the event.
	Write(event PublishableEvent) error
}

Publisher accepts and sends events.

type SubscribableEvent

type SubscribableEvent interface {
	Event
	// WithPayload takes a serialized event and un-serializes it
	WithPayload(payload []byte) error
}

type Subscriber

type Subscriber interface {
	AddHandler(eventTypes []string, handler SubscriberHandlerFunc) error
	Subscribe(ctx context.Context) error
}

type SubscriberHandlerFunc

type SubscriberHandlerFunc func(eventType string, payload []byte) error