events

Documentation

Index

• Constants
• type Event
• type EventHandler
• type Publisher
• type Subscriber

Constants

const (
	UnpublishedEventsCheckInterval        = 1 * time.Minute
	ConnCheckInterval                     = 100 * time.Millisecond
	MaxUnpublishedEvents           uint64 = 1e4
	MaxEventStreamLen              int64  = 1e6
)

Types

type Event

type Event interface {
	// Encode encodes event to map.
	Encode() (map[string]interface{}, error)
}

Event represents an event.

type EventHandler

type EventHandler interface {
	// Handle handles events passed by underlying implementation.
	Handle(ctx context.Context, event Event) error
}

EventHandler represents event handler for Subscriber.

type Publisher

type Publisher interface {
	// Publish publishes event to stream.
	Publish(ctx context.Context, event Event) error

	// Close gracefully closes event publisher's connection.
	Close() error
}

Publisher specifies events publishing API.

type Subscriber

type Subscriber interface {
	// Subscribe subscribes to the event stream and consumes events.
	Subscribe(ctx context.Context, handler EventHandler) error

	// Close gracefully closes event subscriber's connection.
	Close() error
}

Subscriber specifies event subscription API.