objectset

Documentation

Index

• type LockableRegister
  • func NewLockableRegister(name string, apply apply.Apply, scf controller.SharedControllerFactory, ...) (start.Starter, LockableRegister, *controller.SharedHandler)
• type Locker
• type Register

Types

type LockableRegister

type LockableRegister interface {
	Register
	Locker
}

LockableRegister implements Register and Locker

func NewLockableRegister

func NewLockableRegister(name string, apply apply.Apply, scf controller.SharedControllerFactory, discovery discovery.DiscoveryInterface, opts *controller.Options) (start.Starter, LockableRegister, *controller.SharedHandler)

NewLockableRegister returns a starter that starts an ObjectSetController listening to events on ObjectSetStates and a LockableRegister that allows you to register new states for ObjectSets in memory

type Locker

type Locker interface {
	// Lock allows you to lock an objectset associated with a specific key
	Lock(key relatedresource.Key)

	// Unlock allows you to unlock an objectset associated with a specific key
	Unlock(key relatedresource.Key)
}

Locker can lock or unlock object sets tied to a specific key

type Register

type Register interface {
	relatedresource.Enqueuer

	// Set allows you to set and lock an objectset associated with a specific key
	// if os or locked are not provided, the currently persisted values will be used
	Set(key relatedresource.Key, os *objectset.ObjectSet, locked *bool)

	// Delete allows you to delete an objectset associated with a specific key
	Delete(key relatedresource.Key, purge bool)
}

Register can keep track of sets of ObjectSets