keylock

Documentation

Index

• type KeyLock
  • func NewKeyLock[K comparable]() *KeyLock[K]
  • func (kl *KeyLock[K]) Lock(key K, timeout time.Duration, ttl time.Duration) (handle int64)
  • func (kl *KeyLock[K]) Unlock(key K, handle int64)

Types

type KeyLock

type KeyLock[K comparable] struct {
	// contains filtered or unexported fields
}

KeyLock is a simple implementation of key based locks with ttl's on them

func NewKeyLock

func NewKeyLock[K comparable]() *KeyLock[K]

func (*KeyLock[K]) Lock

func (kl *KeyLock[K]) Lock(key K, timeout time.Duration, ttl time.Duration) (handle int64)

Lock attempts to lock the key for the given duration ttl, blocking until it succeeds or the timeout passes.

Specifically, if the key is currently locked by another caller and cannot be obtained within timeout, Lock returns -1. Otherwise, Lock returns a non-negative handle that can be passed to KeyLock.Lock to unlock the key before the ttl expires. (The lock handle guards against the case where callers attempt to unlock keys that have already expired and have since been re-locked by a different caller.)

func (*KeyLock[K]) Unlock

func (kl *KeyLock[K]) Unlock(key K, handle int64)