service

Documentation

Index

• type CheckIn
  • func NewCheckIn(checkInMonitor CheckInMonitor, registry *metrics.Registry) *CheckIn
  • func (s *CheckIn) CheckInName() string
  • func (s *CheckIn) RecordCheckIn(at time.Time) RecordCheckInResult
  • func (s *CheckIn) Snapshot() SnapshotResult
• type CheckInMonitor
• type RecordCheckInResult
• type SnapshotResult

Types

type CheckIn

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

CheckIn records incoming check-ins and owns application side effects such as metrics.

func NewCheckIn

func NewCheckIn(checkInMonitor CheckInMonitor, registry *metrics.Registry) *CheckIn

NewCheckIn creates a check-in service.

func (*CheckIn) CheckInName

func (s *CheckIn) CheckInName() string

CheckInName returns the configured check-in monitor name.

func (*CheckIn) RecordCheckIn

func (s *CheckIn) RecordCheckIn(at time.Time) RecordCheckInResult

RecordCheckIn records a check-in and returns its new check-in monitor state.

func (*CheckIn) Snapshot

func (s *CheckIn) Snapshot() SnapshotResult

Snapshot returns the current check-in monitor snapshot.

type CheckInMonitor

type CheckInMonitor interface {
	CheckInName() string
	RecordCheckIn(at time.Time) monitor.RecordResult
	Snapshot() monitor.Snapshot
}

CheckInMonitor exposes the check-in monitor behavior used by the check-in service.

type RecordCheckInResult

type RecordCheckInResult struct {
	CheckInName   string
	Snapshot      monitor.Snapshot
	PreviousPhase monitor.Phase
}

RecordCheckInResult describes the outcome of recording a check-in.

type SnapshotResult

type SnapshotResult struct {
	CheckInName           string
	Snapshot              monitor.Snapshot
	NotificationStatus    delivery.Status
	HasNotificationStatus bool
}

SnapshotResult describes a check-in monitor snapshot.