Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

dplock

package

Go to main page

Versions in this module

v1

v1.8.0

Sep 20, 2021

Changes in this version

+ const AcquireRetryLogThreshold

+ const DefaultAcquireMaxPeriodMillis

+ const DefaultAcquireMinPeriodMillis

+ const DefaultAcquireRetryTimeout

+ const DefaultMaxCount

+ const DefaultPurgerPeriod

+ const DefaultTTL

+ const DefaultTimeThresholdSinceLastRelease

+ const DefaultUnlockMaxPeriodMillis

+ const DefaultUnlockMinPeriodMillis

+ const DefaultUnlockRetryTimeout

+ const DefaultUsageSleep

+ const MinAllowedPurgerPeriod

+ const UnlockRetryLogThreshold

+ var ErrAcquireTimeout = errors.New("cannot acquire lock, acquire retry timeout has expired")

+ var ErrUnlockTimeout = errors.New("cannot unlock, unlock retry timeout has expired")

+ var Sleep = func(d time.Duration)

+ type Config struct

+ AcquireMaxPeriodMillis uint

+ AcquireMinPeriodMillis uint

+ AcquireRetryTimeout time.Duration

+ MaxCount uint

+ PurgerPeriod time.Duration

+ TTL uint

+ TimeThresholdSinceLastRelease time.Duration

+ UnlockMaxPeriodMillis uint

+ UnlockMinPeriodMillis uint

+ UnlockRetryTimeout time.Duration

+ UsageSleep time.Duration

+ func GetConfig(cfgOverride *ConfigOverride) Config

+ func (c *Config) Validate() error

+ type ConfigOverride struct

+ AcquireMaxPeriodMillis *uint

+ AcquireMinPeriodMillis *uint

+ AcquireRetryTimeout *time.Duration

+ MaxCount *uint

+ PurgerPeriod *time.Duration

+ TTL *uint

+ TimeThresholdSinceLastRelease *time.Duration

+ UnlockMaxPeriodMillis *uint

+ UnlockMinPeriodMillis *uint

+ UnlockRetryTimeout *time.Duration

+ UsageSleep *time.Duration

type Lock

+ Cfg Config

+ Usages Usages

+ func (l *Lock) GetResourceName(resourceID string) string

+ type Usage struct

+ Count uint

+ Released time.Time

+ type Usages struct

+ UsagesMap map[string]map[string]*Usage

+ func NewUsages(cfg *Config) Usages

+ func (u Usages) Purge()

+ func (u Usages) Remove(resourceID, uniqueCallerName string)

+ func (u Usages) SetCount(resourceID, uniqueCallerName string)

+ func (u Usages) SetReleased(resourceID, uniqueCallerName string, releasedTime time.Time)

+ func (u Usages) WaitIfNeeded(resourceID, uniqueCallerName string)

v1.7.1

Sep 17, 2021

v1.7.0

Aug 16, 2021

Changes in this version

+ var ErrUnlockMaxRetries = errors.New("cannot unlock, maximum number of retries has been reached")

+ var UnlockMaxRetries = 100

+ var UnlockPeriod = 5 * time.Millisecond

v1.6.0

Jul 23, 2021

v1.5.0

Oct 26, 2020

v1.4.0

Aug 24, 2020

v1.3.0

Jul 3, 2020

Changes in this version

+ const PurgerPeriod

+ const TTL

+ var AcquireMaxRetries = 10

+ var AcquirePeriod = 250 * time.Millisecond

+ var ErrAcquireMaxRetries = errors.New("cannot acquire lock, maximum number of retries has been reached")

+ var ErrMongoDbClosing = errors.New("mongo db is being closed")

+ var GenerateTimeID = func() int

+ type Client interface

+ Unlock func(lockID string) ([]lock.LockStatus, error)

+ XLock func(resourceName, lockID string, ld lock.LockDetails) error

+ type Lock struct

+ Client Client

+ CloserChannel chan struct{}

+ Purger Purger

+ Resource string

+ WaitGroup *sync.WaitGroup

+ func New(ctx context.Context, session *mgo.Session, db, resource string) *Lock

+ func (l *Lock) Acquire(ctx context.Context, id string) (lockID string, err error)

+ func (l *Lock) Close(ctx context.Context)

+ func (l *Lock) Init(ctx context.Context, lockClient Client, lockPurger Purger)

+ func (l *Lock) Lock(resourceID string) (lockID string, err error)

+ func (l *Lock) Unlock(lockID string) error

+ type Purger interface

+ Purge func() ([]lock.LockStatus, error)

Other modules containing this package

github.com/ONSdigital/dp-mongodb/v2

github.com/ONSdigital/dp-mongodb/v3