lock

package

v1.0.0 Latest Latest Go to latest Published: Mar 6, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

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

DistributedLock provides distributed locking using Redis.

func NewDistributedLock(client *redis.Client, key string, ttl time.Duration) *DistributedLock

NewDistributedLock creates a new distributed lock.

func (l *DistributedLock) Acquire(ctx context.Context) error

Acquire blocks until the lock is acquired or context is canceled.

func (l *DistributedLock) Extend(ctx context.Context) error

Extend extends the lock TTL if we still own it.

func (l *DistributedLock) IsHeld(ctx context.Context) (bool, error)

IsHeld checks if we currently hold the lock.

func (l *DistributedLock) Release(ctx context.Context) error

Release releases the lock if we own it Uses Lua script for atomic check-and-delete.

func (l *DistributedLock) TryAcquire(ctx context.Context) (bool, error)

TryAcquire attempts to acquire the lock without blocking Returns true if lock was acquired, false otherwise.

func (l *DistributedLock) TryWithLock(
	ctx context.Context,
	fn func(ctx context.Context) error,
) (bool, error)

TryWithLock executes a function if the lock can be acquired Returns false if lock was not acquired.

func (l *DistributedLock) WithLock(ctx context.Context, fn func(ctx context.Context) error) error

WithLock executes a function while holding the lock Automatically acquires before and releases after.