locking

Documentation

Index

• Constants
• Variables
• type InMemLocker
  • func NewInMemLocker() *InMemLocker
  • func (l *InMemLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)
  • func (l *InMemLocker) Close() error
  • func (l *InMemLocker) Release(ctx context.Context, key string) error
• type Locker
• type NATSLocker
  • func NewNATSLocker(ctx context.Context, nc *nats.Conn, bucketName string) (*NATSLocker, error)
  • func (l *NATSLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)
  • func (l *NATSLocker) Close() error
  • func (l *NATSLocker) Release(ctx context.Context, key string) error
• type RedisLocker
  • func NewRedisLocker(client *redis.Client) *RedisLocker
  • func (l *RedisLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)
  • func (l *RedisLocker) Close() error
  • func (l *RedisLocker) Release(ctx context.Context, key string) error

Constants

const LockOwnerKey contextKey = "lock_owner"

Variables

var (
	ErrLockAcquisitionTimeout = errors.New("lock acquisition timed out")
	ErrLockNotHeld            = errors.New("lock not held")
)

Types

type InMemLocker

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

InMemLocker is a simple thread-safe in-memory locker.

func NewInMemLocker

func NewInMemLocker() *InMemLocker

NewInMemLocker creates a new InMemLocker.

func (*InMemLocker) Acquire

func (l *InMemLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)

func (*InMemLocker) Close

func (l *InMemLocker) Close() error

func (*InMemLocker) Release

func (l *InMemLocker) Release(ctx context.Context, key string) error

type Locker

type Locker interface {
	// Acquire attempts to acquire a lock for the given key.
	// ttl is the maximum time the lock can be held before auto-expiring.
	// timeout is the maximum time to wait for the lock to become available.
	Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)

	// Release releases the lock for the given key.
	Release(ctx context.Context, key string) error

	// Close shuts down the locker.
	Close() error
}

Locker defines the interface for distributed locking.

type NATSLocker

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

NATSLocker implements Locker using NATS JetStream KeyValue.

func NewNATSLocker

func NewNATSLocker(ctx context.Context, nc *nats.Conn, bucketName string) (*NATSLocker, error)

NewNATSLocker creates a new NATSLocker.

func (*NATSLocker) Acquire

func (l *NATSLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)

func (*NATSLocker) Close

func (l *NATSLocker) Close() error

func (*NATSLocker) Release

func (l *NATSLocker) Release(ctx context.Context, key string) error

type RedisLocker

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

RedisLocker implements Locker using Redis.

func NewRedisLocker

func NewRedisLocker(client *redis.Client) *RedisLocker

NewRedisLocker creates a new RedisLocker.

func (*RedisLocker) Acquire

func (l *RedisLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)

func (*RedisLocker) Close

func (l *RedisLocker) Close() error

func (*RedisLocker) Release

func (l *RedisLocker) Release(ctx context.Context, key string) error