events

Documentation

Overview

Package events package

Index

• type EventManager
  • func NewEventManager(dbClient *db.Client, logger logger.Logger) *EventManager
  • func (e *EventManager) Start(ctx context.Context)
  • func (e *EventManager) Subscribe(subscriptions []Subscription) *Subscriber
  • func (e *EventManager) Unsubscribe(subscriber *Subscriber)
• type Subscriber
  • func (s *Subscriber) GetEvent(ctx context.Context) (*db.Event, error)
• type Subscription
• type SubscriptionAction
• type SubscriptionType

Types

type EventManager

type EventManager struct {
	// contains filtered or unexported fields
}

EventManager is used to subscribe to database events

func NewEventManager

func NewEventManager(dbClient *db.Client, logger logger.Logger) *EventManager

NewEventManager creates a new instance of EventManager

func (*EventManager) Start

func (e *EventManager) Start(ctx context.Context)

Start will start the event loop for listing to database events

func (*EventManager) Subscribe

func (e *EventManager) Subscribe(subscriptions []Subscription) *Subscriber

Subscribe creates a Subscriber that will be notified of database events based on the specified subscriptions

func (*EventManager) Unsubscribe

func (e *EventManager) Unsubscribe(subscriber *Subscriber)

Unsubscribe removes the subscriber

type Subscriber

type Subscriber struct {
	ID string
	// contains filtered or unexported fields
}

Subscriber is used to subscribe to database events

func (*Subscriber) GetEvent

func (s *Subscriber) GetEvent(ctx context.Context) (*db.Event, error)

GetEvent blocks until an event is available

type Subscription

type Subscription struct {
	Type    SubscriptionType
	ID      string               // Optional ID of resource to subscribe to
	Actions []SubscriptionAction // Empty Actions list will subscribe to all action types
}

Subscription includes the model type to subscribe to

type SubscriptionAction

type SubscriptionAction string

SubscriptionAction type represents the available actions that can be subscribed type

const (
	CreateAction SubscriptionAction = "INSERT"
	UpdateAction SubscriptionAction = "UPDATE"
	DeleteAction SubscriptionAction = "DELETE"
)

SubscriptionAction constants

type SubscriptionType

type SubscriptionType string

SubscriptionType specifies the type of subscription

const (
	JobSubscription             SubscriptionType = "jobs"
	LogStreamSubscription       SubscriptionType = "log_streams"
	RunSubscription             SubscriptionType = "runs"
	WorkspaceSubscription       SubscriptionType = "workspaces"
	RunnerSubscription          SubscriptionType = "runners"
	MaintenanceModeSubscription SubscriptionType = "maintenance_mode"
	RunnerSessionSubscription   SubscriptionType = "runner_sessions"
)

SubscriptionType constants