subsystems

Documentation

Overview

Package subsystems defines the subsystem interface.

Index

• type Subsystem

Types

type Subsystem

type Subsystem interface {
	// Start runs the subsystem
	Start(ctx context.Context) error

	// Stop signals the subsystem to shutdown
	Stop(ctx context.Context) error

	// Update validates and/or updates a subsystem, returns true if subsystem should be restarted
	Update(ctx context.Context, cfg *pb.DeviceSubsystemConfig) (bool, error)

	// HealthCheck reports if a subsystem is running correctly (it is restarted if not)
	HealthCheck(ctx context.Context) error

	// Version returns the current version of the subsystem
	Version() string
}