noop

Documentation

Overview

Package noop implements a no-op target locker.

Index

• Variables
• func New() target.Locker
• type Noop
  • func (tl Noop) Close() error
  • func (tl Noop) Lock(ctx xcontext.Context, _ types.JobID, _ time.Duration, targets []*target.Target) error
  • func (tl Noop) RefreshLocks(ctx xcontext.Context, jobID types.JobID, _ time.Duration, ...) error
  • func (tl Noop) TryLock(ctx xcontext.Context, _ types.JobID, _ time.Duration, targets []*target.Target, ...) ([]string, error)
  • func (tl Noop) Unlock(ctx xcontext.Context, _ types.JobID, targets []*target.Target) error

Variables

var Name = "Noop"

Name is the name used to look this plugin up.

Functions

func New

func New() target.Locker

New initializes and returns a new ExampleTestStep.

Types

type Noop

type Noop struct {
}

Noop is the no-op target locker. It does nothing.

func (Noop) Close

func (tl Noop) Close() error

func (Noop) Lock

func (tl Noop) Lock(ctx xcontext.Context, _ types.JobID, _ time.Duration, targets []*target.Target) error

Lock locks the specified targets by doing nothing.

func (Noop) RefreshLocks

func (tl Noop) RefreshLocks(ctx xcontext.Context, jobID types.JobID, _ time.Duration, targets []*target.Target) error

RefreshLocks refreshes all the locks by the internal (non-existing) timeout, by flawlessly doing nothing.

func (Noop) TryLock

func (tl Noop) TryLock(ctx xcontext.Context, _ types.JobID, _ time.Duration, targets []*target.Target, limit uint) ([]string, error)

TryLock locks the specified targets by doing nothing.

func (Noop) Unlock

func (tl Noop) Unlock(ctx xcontext.Context, _ types.JobID, targets []*target.Target) error

Unlock unlocks the specified targets by doing nothing.