plugin

Documentation

Index

• type Callback
• type Event
  • func (e Event) String() string
• type Notification
• type Plugin

Types

type Callback

type Callback struct {
	Event Event
	Value interface{}
}

type Event

type Event int

Event defines the type of notification from controller to plugins

const (
	EvtKeyboardFn Event = iota
	EvtACPISuspend
	EvtACPIResume
	EvtChargerPluggedIn
	EvtChargerUnplugged
	EvtSentinelCycleThermalProfile
	EvtSentinelUtilityKey
	EvtSentinelEnableGPU
	EvtSentinelDisableGPU
	EvtSentinelCycleRefreshRate

	CbPersistConfig
	CbNotifyToast
	CbNotifyClients
)

Define all the possible controller->plugin notifications

func (Event) String

func (e Event) String() string

type Notification

type Notification struct {
	Event Event
	Value interface{}
}

Notification facilitates the hardware event to be sent to plugins

type Plugin

type Plugin interface {
	Initialize() error
	Run(haltCtx context.Context, cb chan<- Callback) <-chan error
	Notify(t Notification)
}

Plugin will receive hardware events from controller