lockr

package

v1.0.0-beta.217 Latest Latest Go to latest Published: Jul 14, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation ¶

This section is empty.

View Source

var ErrLockTimeout = errors.New("lock operation timed out")

ErrLockTimeout is returned when a lock operation times out

This section is empty.

type Key interface {
	String() string
	Hash64() uint64
}

Key is a unique identifier for a resource and a scope that can be locked

func NewKey(scope string, scopes ...string) (Key, error)

NewKey constructs a key for the given scopes. Scope is always required and must be non-empty.

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

Locker is the generic interface for distributed business level locks.

func NewLocker(cfg *LockerConfig) (*Locker, error)

func (l *Locker) LockForTX(ctx context.Context, key Key) error

LockForTX locks the key for the duration of the transaction.

type LockerConfig struct {
	Logger *slog.Logger
}

func (c *LockerConfig) Validate() error