GF
Go Foundation API
lock API

lock

package

API reference for the lock package.

Imports

(2)
STD context STD time
I
interface

Locker

Locker defines the interface for distributed or local locks.

pkg/lock/locker.go:15-25 
type Locker interface

Example 

// Assuming a RedisLocker implementation
locker := NewRedisLocker(redisClient)
locker.Acquire(ctx, "my-resource", 5*time.Second)

Methods

Acquire
Method

Parameters

ctx context.Context
key string
ttl time.Duration

Returns

error 
func Acquire(...)
TryLock
Method

Parameters

ctx context.Context
key string
ttl time.Duration

Returns

bool
error 
func TryLock(...)
Release
Method

Parameters

ctx context.Context
key string

Returns

error 
func Release(...)