system

Documentation

Index

• type GormStore
  • func (s *GormStore) GetSettings() (*Settings, error)
  • func (s *GormStore) SaveSettings(settings *Settings) error
• type Service
  • func NewService(store Store, opts ...ServiceOption) Service
• type ServiceImpl
  • func (svc *ServiceImpl) GetSettings() (*Settings, error)
  • func (svc *ServiceImpl) IsHalted() (bool, error)
  • func (svc *ServiceImpl) Pause() error
  • func (svc *ServiceImpl) Resume() error
  • func (svc *ServiceImpl) SaveSettings(settings *Settings) error
• type ServiceOption
  • func WithPauseDuration(duration time.Duration) ServiceOption
• type Settings
  • func (s *Settings) FromJSON(j SettingsJSON)
  • func (s *Settings) IsMaintenanceMode() bool
  • func (s *Settings) IsPaused(pauseDuration time.Duration) bool
  • func (s *Settings) String() string
  • func (Settings) TableName() string
  • func (s *Settings) ToJSON() SettingsJSON
• type SettingsJSON
• type Store
  • func NewGormStore(db *gorm.DB) Store

Types

type GormStore

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

func (*GormStore) GetSettings

func (s *GormStore) GetSettings() (*Settings, error)

func (*GormStore) SaveSettings

func (s *GormStore) SaveSettings(settings *Settings) error

type Service

type Service interface {
	GetSettings() (*Settings, error)
	SaveSettings(settings *Settings) error
	// Pauses the system for a configured duration
	Pause() error
	// Will immediately revoke the pause timer
	Resume() error
	IsHalted() (bool, error)
}

func NewService

func NewService(store Store, opts ...ServiceOption) Service

type ServiceImpl

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

func (*ServiceImpl) GetSettings

func (svc *ServiceImpl) GetSettings() (*Settings, error)

func (*ServiceImpl) IsHalted

func (svc *ServiceImpl) IsHalted() (bool, error)

func (*ServiceImpl) Pause

func (svc *ServiceImpl) Pause() error

func (*ServiceImpl) Resume

func (svc *ServiceImpl) Resume() error

func (*ServiceImpl) SaveSettings

func (svc *ServiceImpl) SaveSettings(settings *Settings) error

type ServiceOption

type ServiceOption func(*ServiceImpl)

func WithPauseDuration

func WithPauseDuration(duration time.Duration) ServiceOption

type Settings

type Settings struct {
	gorm.Model
	MaintenanceMode bool         `gorm:"column:maintenance_mode;default:false"`
	PausedSince     sql.NullTime `gorm:"column:paused_since"`
}

func (*Settings) FromJSON

func (s *Settings) FromJSON(j SettingsJSON)

Update fields according to JSON version

func (*Settings) IsMaintenanceMode

func (s *Settings) IsMaintenanceMode() bool

func (*Settings) IsPaused

func (s *Settings) IsPaused(pauseDuration time.Duration) bool

func (*Settings) String

func (s *Settings) String() string

func (Settings) TableName

func (Settings) TableName() string

func (*Settings) ToJSON

func (s *Settings) ToJSON() SettingsJSON

Convert to JSON version

type SettingsJSON

type SettingsJSON struct {
	MaintenanceMode bool `json:"maintenanceMode"`
}

type Store

type Store interface {
	GetSettings() (*Settings, error)
	SaveSettings(*Settings) error
}

func NewGormStore

func NewGormStore(db *gorm.DB) Store