out

Documentation

Index

• Variables
• type GitLockHandler
  • func NewGitLockHandler(source Source) *GitLockHandler
  • func (glh *GitLockHandler) AddLock(lock string, contents []byte, initiallyClaimed bool) (string, error)
  • func (glh *GitLockHandler) BroadcastLockPool() ([]byte, error)
  • func (glh *GitLockHandler) CheckLock(lockName string) (string, error)
  • func (glh *GitLockHandler) CheckUnclaimedLock(lockName string) (string, error)
  • func (glh *GitLockHandler) ClaimLock(lockName string) (string, error)
  • func (glh *GitLockHandler) GrabAvailableLock() (string, string, error)
  • func (glh *GitLockHandler) RemoveLock(lockName string) (string, error)
  • func (glh *GitLockHandler) ResetLock() error
  • func (glh *GitLockHandler) Setup() error
  • func (glh *GitLockHandler) UnclaimLock(lockName string) (string, error)
  • func (glh *GitLockHandler) UpdateLock(lockName string, contents []byte) (string, error)
• type LockHandler
• type LockPool
  • func NewLockPool(source Source, output io.Writer) LockPool
  • func (lp *LockPool) AcquireLock() (string, Version, error)
  • func (lp *LockPool) AddClaimedLock(inDir string) (string, Version, error)
  • func (lp *LockPool) AddUnclaimedLock(inDir string) (string, Version, error)
  • func (lp *LockPool) CheckLock(inDir string) (string, Version, error)
  • func (lp *LockPool) CheckUnclaimedLock(inDir string) (string, Version, error)
  • func (lp *LockPool) ClaimLock(lock string) (Version, error)
  • func (lp *LockPool) ReleaseLock(inDir string) (string, Version, error)
  • func (lp *LockPool) RemoveLock(inDir string) (string, Version, error)
  • func (lp *LockPool) UpdateLock(inDir string) (string, Version, error)
• type MetadataPair
• type OutParams
• type OutRequest
  • func (request OutRequest) Validate() []string
• type OutResponse
• type Source
  • func (s *Source) UnmarshalJSON(b []byte) error
• type Version

Variables

var ErrLockActive = errors.New("lock found")

var ErrLockConflict = errors.New("pool state out of date")

var ErrNoLocksAvailable = errors.New("no locks to claim")

Types

type GitLockHandler

type GitLockHandler struct {
	Source Source
	// contains filtered or unexported fields
}

func NewGitLockHandler

func NewGitLockHandler(source Source) *GitLockHandler

func (*GitLockHandler) AddLock

func (glh *GitLockHandler) AddLock(lock string, contents []byte, initiallyClaimed bool) (string, error)

func (*GitLockHandler) BroadcastLockPool

func (glh *GitLockHandler) BroadcastLockPool() ([]byte, error)

func (*GitLockHandler) CheckLock

func (glh *GitLockHandler) CheckLock(lockName string) (string, error)

func (*GitLockHandler) CheckUnclaimedLock

func (glh *GitLockHandler) CheckUnclaimedLock(lockName string) (string, error)

func (*GitLockHandler) ClaimLock

func (glh *GitLockHandler) ClaimLock(lockName string) (string, error)

func (*GitLockHandler) GrabAvailableLock

func (glh *GitLockHandler) GrabAvailableLock() (string, string, error)

func (*GitLockHandler) RemoveLock

func (glh *GitLockHandler) RemoveLock(lockName string) (string, error)

func (*GitLockHandler) ResetLock

func (glh *GitLockHandler) ResetLock() error

func (*GitLockHandler) Setup

func (glh *GitLockHandler) Setup() error

func (*GitLockHandler) UnclaimLock

func (glh *GitLockHandler) UnclaimLock(lockName string) (string, error)

func (*GitLockHandler) UpdateLock

func (glh *GitLockHandler) UpdateLock(lockName string, contents []byte) (string, error)

type LockHandler

type LockHandler interface {
	GrabAvailableLock() (lock string, version string, err error)
	UnclaimLock(lock string) (version string, err error)
	AddLock(lock string, contents []byte, initiallyClaimed bool) (version string, err error)
	RemoveLock(lock string) (version string, err error)
	ClaimLock(lock string) (version string, err error)
	UpdateLock(lock string, contents []byte) (version string, err error)
	CheckLock(lock string) (version string, err error)
	CheckUnclaimedLock(lock string) (version string, err error)

	Setup() error
	BroadcastLockPool() ([]byte, error)
	ResetLock() error
}

type LockPool

type LockPool struct {
	Source Source
	Output io.Writer

	LockHandler LockHandler
	// contains filtered or unexported fields
}

func NewLockPool

func NewLockPool(source Source, output io.Writer) LockPool

func (*LockPool) AcquireLock

func (lp *LockPool) AcquireLock() (string, Version, error)

func (*LockPool) AddClaimedLock

func (lp *LockPool) AddClaimedLock(inDir string) (string, Version, error)

func (*LockPool) AddUnclaimedLock

func (lp *LockPool) AddUnclaimedLock(inDir string) (string, Version, error)

func (*LockPool) CheckLock

func (lp *LockPool) CheckLock(inDir string) (string, Version, error)

func (*LockPool) CheckUnclaimedLock

func (lp *LockPool) CheckUnclaimedLock(inDir string) (string, Version, error)

func (*LockPool) ClaimLock

func (lp *LockPool) ClaimLock(lock string) (Version, error)

func (*LockPool) ReleaseLock

func (lp *LockPool) ReleaseLock(inDir string) (string, Version, error)

func (*LockPool) RemoveLock

func (lp *LockPool) RemoveLock(inDir string) (string, Version, error)

func (*LockPool) UpdateLock

func (lp *LockPool) UpdateLock(inDir string) (string, Version, error)

type MetadataPair

type MetadataPair struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type OutParams

type OutParams struct {
	Release        string `json:"release"`
	Acquire        bool   `json:"acquire"`
	Add            string `json:"add"`
	AddClaimed     string `json:"add_claimed"`
	Remove         string `json:"remove"`
	Claim          string `json:"claim"`
	Update         string `json:"update"`
	Check          string `json:"check"`
	CheckUnclaimed string `json:"check_unclaimed"`
}

type OutRequest

type OutRequest struct {
	Source Source    `json:"source"`
	Params OutParams `json:"params"`
}

func (OutRequest) Validate

func (request OutRequest) Validate() []string

type OutResponse

type OutResponse struct {
	Version  Version        `json:"version"`
	Metadata []MetadataPair `json:"metadata"`
}

type Source

type Source struct {
	URI        string        `json:"uri"`
	Branch     string        `json:"branch"`
	PrivateKey string        `json:"private_key" mapstructure:"private_key"`
	Pool       string        `json:"pool"`
	RetryDelay time.Duration `json:"retry_delay" mapstructure:"retry_delay"`
}

func (*Source) UnmarshalJSON

func (s *Source) UnmarshalJSON(b []byte) error

type Version

type Version struct {
	Ref string `json:"ref"`
}