cleaner

Documentation

Index

• type CleanerAPI
  • func NewCleanerAPI(st *state.State, res *common.Resources, authorizer common.Authorizer) (*CleanerAPI, error)
  • func (api *CleanerAPI) Cleanup() error
  • func (api *CleanerAPI) WatchCleanups() (params.NotifyWatchResult, error)
• type StateInterface

Types

type CleanerAPI

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

CleanerAPI implements the API used by the cleaner worker.

func NewCleanerAPI

func NewCleanerAPI(
	st *state.State,
	res *common.Resources,
	authorizer common.Authorizer,
) (*CleanerAPI, error)

NewCleanerAPI creates a new instance of the Cleaner API.

func (*CleanerAPI) Cleanup

func (api *CleanerAPI) Cleanup() error

Cleanup triggers a state cleanup

func (*CleanerAPI) WatchCleanups

func (api *CleanerAPI) WatchCleanups() (params.NotifyWatchResult, error)

WatchChanges watches for cleanups to be perfomed in state

type StateInterface

type StateInterface interface {
	Cleanup() error
	WatchCleanups() state.NotifyWatcher
}