state

Documentation

Index

• Constants
• type SharedMutable
  • func New(cluster string) *SharedMutable
  • func (s *SharedMutable) Cluster() string
  • func (s *SharedMutable) Delete(k string)
  • func (s *SharedMutable) Error(e error)
  • func (s *SharedMutable) Get(k string) (val string)
  • func (s *SharedMutable) GetKubeClient() kubernetes.Interface
  • func (s *SharedMutable) InitTimestamp() time.Time
  • func (s *SharedMutable) Set(k string, v string)
  • func (s *SharedMutable) SetErrChannel(errChannel chan error)
  • func (s *SharedMutable) SetKubeClient(client kubernetes.Interface)

Constants

const (
	RUNNING  string = "RUNNING"
	FINISHED string = "FINISHED"
)

Types

type SharedMutable

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

func New

func New(cluster string) *SharedMutable

New() instantiates a SharedMutable state and opens the goroutine listening for setObjects requests. Admiral assumes this is a singleton.

func (*SharedMutable) Cluster

func (s *SharedMutable) Cluster() string

Cluster returns the name of the cluster

func (*SharedMutable) Delete

func (s *SharedMutable) Delete(k string)

Delete sends a key to the deletion channel where run() removes it from the state.

func (*SharedMutable) Error

func (s *SharedMutable) Error(e error)

Error sends an error to the error channel.

func (*SharedMutable) Get

func (s *SharedMutable) Get(k string) (val string)

Get returns a value for the given key.

func (*SharedMutable) GetKubeClient

func (s *SharedMutable) GetKubeClient() kubernetes.Interface

GetKubeClient retrieves the Kubernetes client.

func (*SharedMutable) InitTimestamp

func (s *SharedMutable) InitTimestamp() time.Time

InitTimestamp returns the timestamp of when the SharedMutable state was created.

func (*SharedMutable) Set

func (s *SharedMutable) Set(k string, v string)

Set takes a key/value and sends it to the objects channel where run() adds it to the state.

func (*SharedMutable) SetErrChannel

func (s *SharedMutable) SetErrChannel(errChannel chan error)

SetErrChannel sets a shared error channel.

func (*SharedMutable) SetKubeClient

func (s *SharedMutable) SetKubeClient(client kubernetes.Interface)

SetKubeClient sets the Kubernetes client.