locking

Documentation

Index

• type Interface
• type KubeLock
  • func NewKubeLock(sec *api.Secret) (*KubeLock, error)
  • func (k *KubeLock) GetExpiry() time.Time
  • func (k *KubeLock) GetObject() interface{}
• type KubeProvider
  • func NewKubeProvider(kubeClient *client.Client) (*KubeProvider, error)
  • func (kp *KubeProvider) Lock(lock Interface) (Interface, error)
  • func (kp *KubeProvider) Unlock(lock Interface) (Interface, error)
• type Locking
  • func New(provider Provider) (*Locking, error)
  • func (l *Locking) LockAll(locks ...Interface) ([]Interface, []error)
  • func (l *Locking) UnlockAll(locks ...Interface) ([]Interface, []error)
• type Provider

Types

type Interface

type Interface interface {
	GetObject() interface{}
	GetExpiry() time.Time
}

type KubeLock

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

func NewKubeLock

func NewKubeLock(sec *api.Secret) (*KubeLock, error)

func (*KubeLock) GetExpiry

func (k *KubeLock) GetExpiry() time.Time

func (*KubeLock) GetObject

func (k *KubeLock) GetObject() interface{}

type KubeProvider

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

func NewKubeProvider

func NewKubeProvider(kubeClient *client.Client) (*KubeProvider, error)

func (*KubeProvider) Lock

func (kp *KubeProvider) Lock(lock Interface) (Interface, error)

Lock will acquire a lock by attempting to create a secret with name `name` in the given namespace. If a lock with the same name already exists, it'll check the locks expiry time and if it's less than the current time, will acquire the lock for itself

func (*KubeProvider) Unlock

func (kp *KubeProvider) Unlock(lock Interface) (Interface, error)

type Locking

type Locking struct {
	Provider
}

func New

func New(provider Provider) (*Locking, error)

func (*Locking) LockAll

func (l *Locking) LockAll(locks ...Interface) ([]Interface, []error)

func (*Locking) UnlockAll

func (l *Locking) UnlockAll(locks ...Interface) ([]Interface, []error)

type Provider

type Provider interface {
	Lock(lock Interface) (Interface, error)
	Unlock(lock Interface) (Interface, error)
}