Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

worklease

package module

Go to main page

Versions in this module

v0

v0.5.0

Jun 29, 2026

Changes in this version

+ var ErrLeaseWindowExhausted = errors.New(msgLeaseWindowExhausted)

type RenewEvent

+ Attempt int

type RenewalOption

+ func WithRenewalBackoff(initial, maxInterval time.Duration, jitter float64) RenewalOption

v0.4.0

Jun 17, 2026

Changes in this version

+ type AcquireEvent struct

+ Duration time.Duration

+ Err error

+ Token Token

+ WorkID string

+ type CheckpointEvent struct

+ Duration time.Duration

+ Err error

+ Size int

+ Token Token

+ type FencedEvent struct

+ Operation Operation

+ Token Token

type LeaseObserver

+ OnReadCheckpoint func(ctx context.Context, e ReadCheckpointEvent)

+ type Operation uint8

+ const OperationCheckpoint

+ const OperationRelease

+ const OperationRenew

+ type ReadCheckpointEvent struct

+ CleanHandoff bool

+ Duration time.Duration

+ Err error

+ Size int

+ Token Token

+ type ReleaseEvent struct

+ Duration time.Duration

+ Err error

+ Token Token

+ type RenewEvent struct

+ Duration time.Duration

+ Err error

+ Token Token

v0.3.0

Jun 14, 2026

Changes in this version

+ func HasWaitForLease(opts []AcquireOption) bool

v0.2.0

Jun 10, 2026

Changes in this version

type Config

+ Observer LeaseObserver

+ type LeaseObserver interface

+ OnAcquire func(ctx context.Context, workID string, token Token, err error)

+ OnCheckpoint func(ctx context.Context, token Token, size int, err error)

+ OnFenced func(ctx context.Context, token Token)

+ OnRelease func(ctx context.Context, token Token, err error)

+ OnRenew func(ctx context.Context, token Token, err error)

v0.1.0

Jun 6, 2026

Changes in this version

+ var ErrFenced = errors.New(msgFenced)

+ var ErrLeaseExpired = errors.New(msgLeaseExpired)

+ var ErrLeaseHeld = errors.New(msgLeaseHeld)

+ type AcquireOption func(*acquireConfig)

+ func WithPollInterval(d time.Duration) AcquireOption

+ func WithWaitForLease() AcquireOption

+ type Config struct

+ HolderID string

+ TTL time.Duration

+ type Lease interface

+ Acquire func(ctx context.Context, workID string, opts ...AcquireOption) (Token, error)

+ Checkpoint func(ctx context.Context, token Token, state []byte) error

+ ReadCheckpoint func(ctx context.Context, token Token) (state []byte, cleanHandoff bool, err error)

+ Release func(ctx context.Context, token Token) error

+ Renew func(ctx context.Context, token Token) error

+ StartRenewal func(ctx context.Context, token Token, opts ...RenewalOption) (renewCtx context.Context, stopRenewal func())

+ func New(b backend.Backend, cfg Config) (Lease, error)

+ type RenewalOption func(*renewalConfig)

+ func WithRenewalInterval(d time.Duration) RenewalOption

+ type Token struct

+ func (t Token) ExpiresAt() time.Time

+ func (t Token) FencingToken() uint64

+ func (t Token) HolderID() string

+ func (t Token) String() string

+ func (t Token) WorkID() string