status

Documentation

Index

• Variables
• func NewReportStatusFunc(id *componentstatus.InstanceID, srvStatus ServiceStatusFunc) func(*componentstatus.Event)
• type InvalidTransitionFunc
• type NotifyStatusFunc
• type Reporter
  • func NewReporter(onStatusChange NotifyStatusFunc, onInvalidTransition InvalidTransitionFunc) Reporter
• type ServiceStatusFunc

Variables

var ErrStatusNotReady = errors.New("report component status is not ready until service start")

ErrStatusNotReady is returned when trying to report status before service start

Functions

func NewReportStatusFunc

func NewReportStatusFunc(
	id *componentstatus.InstanceID,
	srvStatus ServiceStatusFunc,
) func(*componentstatus.Event)

NewReportStatusFunc returns a function to be used as ReportStatus for componentstatus.TelemetrySettings

Types

type InvalidTransitionFunc

type InvalidTransitionFunc func(error)

InvalidTransitionFunc is the receiver of invalid transition errors

type NotifyStatusFunc

type NotifyStatusFunc func(*componentstatus.InstanceID, *componentstatus.Event)

NotifyStatusFunc is the receiver of status events after successful state transitions

type Reporter

type Reporter interface {
	ReportStatus(id *componentstatus.InstanceID, ev *componentstatus.Event)
	ReportOKIfStarting(id *componentstatus.InstanceID)
}

Reporter handles component status reporting

func NewReporter

func NewReporter(onStatusChange NotifyStatusFunc, onInvalidTransition InvalidTransitionFunc) Reporter

NewReporter returns a reporter that will invoke the NotifyStatusFunc when a component's status has changed.

type ServiceStatusFunc

type ServiceStatusFunc func(*componentstatus.InstanceID, *componentstatus.Event)

ServiceStatusFunc is the expected type of ReportStatus