engine

Documentation

Index

• type Config
• type Engine
  • func NewEngine(ctx context.Context, db *sql.DB, c *Config) (*Engine, error)
  • func (p *Engine) Pause(ctx context.Context) error
  • func (p *Engine) Receive(ctx context.Context, callbackID string, result notification.Result) error
  • func (p *Engine) Resume(ctx context.Context) error
  • func (p *Engine) Run(ctx context.Context) error
  • func (p *Engine) Shutdown(ctx context.Context) error
  • func (p *Engine) Start(ctx context.Context, d notification.Dest) error
  • func (p *Engine) Stop(ctx context.Context, d notification.Dest) error
  • func (p *Engine) Trigger()
  • func (p *Engine) TriggerAndWaitNextCycle(ctx context.Context) error
  • func (p *Engine) UpdateStatus(ctx context.Context, status *notification.MessageStatus) error
  • func (p *Engine) WaitNextCycle(ctx context.Context) error

Types

type Config

type Config struct {
	AlertLogStore      alertlog.Store
	AlertStore         alert.Store
	ContactMethodStore contactmethod.Store
	NotificationSender notification.Sender
	UserStore          user.Store
	NotificationStore  notification.Store
	NCStore            notificationchannel.Store

	ConfigSource config.Source

	Keys keyring.Keys

	MaxMessages int

	DisableCycle bool
}

Config contains parameters for controlling how the Engine operates.

type Engine

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

Engine handles automatic escaltion of unacknowledged(triggered) alerts, as well as passing to-be-sent notifications to the notification.Sender.

Care is taken to ensure only one attempt is made per contact-method at a time, regardless of how many instances of the application may be running.

func NewEngine

func NewEngine(ctx context.Context, db *sql.DB, c *Config) (*Engine, error)

NewEngine will create a new Engine using the passed *sql.DB as a backend. Outgoing notifications will be passed to Sender.

Context is only used for preparing and initializing.

func (*Engine) Pause

func (p *Engine) Pause(ctx context.Context) error

Pause will attempt to gracefully stop engine processing.

func (*Engine) Receive

func (p *Engine) Receive(ctx context.Context, callbackID string, result notification.Result) error

Receive will process a notification result.

func (*Engine) Resume

func (p *Engine) Resume(ctx context.Context) error

Resume will allow the engine to resume processing.

func (*Engine) Run

func (p *Engine) Run(ctx context.Context) error

Run will being the engine loop.

func (*Engine) Shutdown

func (p *Engine) Shutdown(ctx context.Context) error

Shutdown will gracefully shutdown the processor, finishing any ongoing tasks.

func (*Engine) Start

func (p *Engine) Start(ctx context.Context, d notification.Dest) error

Start will enable all associated contact methods of `value` with type `t`. This should be invoked if a user, for example, responds with `START` via sms.

func (*Engine) Stop

func (p *Engine) Stop(ctx context.Context, d notification.Dest) error

Stop will disable all associated contact methods of `value` with type `t`. This should be invoked if a user, for example, responds with `STOP` via SMS.

func (*Engine) Trigger

func (p *Engine) Trigger()

Trigger will force notifications to be processed immediately.

func (*Engine) TriggerAndWaitNextCycle

func (p *Engine) TriggerAndWaitNextCycle(ctx context.Context) error

TriggerAndWaitNextCycle will force notifications to be processed immediately and will return after the next engine cycle starts and then finishes.

func (*Engine) UpdateStatus

func (p *Engine) UpdateStatus(ctx context.Context, status *notification.MessageStatus) error

UpdateStatus will update the status of a message.

func (*Engine) WaitNextCycle

func (p *Engine) WaitNextCycle(ctx context.Context) error

WaitNextCycle will return after the next engine cycle starts and then finishes.