notifier

Documentation

Index

• type NotificationTopic
• type Notifier
  • func New(archetype *baseservice.Archetype, listener riverdriver.Listener, ...) *Notifier
  • func (n *Notifier) Listen(ctx context.Context, topic NotificationTopic, notifyFunc NotifyFunc) (*Subscription, error)
  • func (n *Notifier) Start(ctx context.Context) error
• type NotifyFunc
• type Subscription
  • func ListenRetryLoop(ctx context.Context, baseService *baseservice.BaseService, notifier *Notifier, ...) (*Subscription, error)
  • func (s *Subscription) Unlisten(ctx context.Context)

Types

type NotificationTopic

type NotificationTopic string

const (
	NotificationTopicInsert     NotificationTopic = "river_insert"
	NotificationTopicLeadership NotificationTopic = "river_leadership"
	NotificationTopicJobControl NotificationTopic = "river_job_control"
)

type Notifier

type Notifier struct {
	baseservice.BaseService
	startstop.BaseStartStop
	// contains filtered or unexported fields
}

func New

func New(archetype *baseservice.Archetype, listener riverdriver.Listener, statusChangeFunc func(componentstatus.Status)) *Notifier

func (*Notifier) Listen

func (n *Notifier) Listen(ctx context.Context, topic NotificationTopic, notifyFunc NotifyFunc) (*Subscription, error)

func (*Notifier) Start

func (n *Notifier) Start(ctx context.Context) error

type NotifyFunc

type NotifyFunc func(topic NotificationTopic, payload string)

type Subscription

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

func ListenRetryLoop

func ListenRetryLoop(ctx context.Context, baseService *baseservice.BaseService, notifier *Notifier, topic NotificationTopic, notifyFunc NotifyFunc) (*Subscription, error)

ListenRetryLoop tries to listen on a notification topic, but with a retry loop in case of an initial failure. This is a stopgap until services like the producer and elector can propagate errors back on start up, and subject to change.

func (*Subscription) Unlisten

func (s *Subscription) Unlisten(ctx context.Context)