locks

Documentation

Index

• Variables
• type ConsulLock
  • func (l *ConsulLock) Lock(ctx context.Context) (chan struct{}, error)
  • func (l *ConsulLock) Unlock(ctx context.Context) error
  • func (l *ConsulLock) WaitForUnlock(ctx context.Context) error
• type ConsulLockPool
  • func NewConsulLockPool(consulAddress string) (ConsulLockPool, error)
  • func (p ConsulLockPool) NewLock(lockName string, expiry time.Duration) *ConsulLock
• type CountDownLatch
  • func NewCountDownLatch() *CountDownLatch
  • func (l *CountDownLatch) Add(delta int)
  • func (l *CountDownLatch) Close()
  • func (l *CountDownLatch) Counter() int
  • func (l *CountDownLatch) Done()
  • func (l *CountDownLatch) Wait() <-chan struct{}
  • func (l *CountDownLatch) WaitWithTimeout(timeout time.Duration) bool
• type Latch
  • func NewLatch() *Latch
  • func (c *Latch) Lock()
  • func (c *Latch) Unlock()
  • func (c *Latch) Wait() <-chan struct{}
• type Mutex
  • func (m *Mutex) Lock()
  • func (m *Mutex) Unlock()
• type RWMutex
  • func (m *RWMutex) Lock()
  • func (m *RWMutex) RLock()
  • func (m *RWMutex) RUnlock()
  • func (m *RWMutex) Unlock()
• type RedisLock
  • func (l RedisLock) Lock() (chan struct{}, error)
  • func (l RedisLock) Unlock() error
• type RedisLockPool
  • func NewRedisLockPool(redisAddresses []string) (RedisLockPool, error)
  • func (p RedisLockPool) NewLock(lockName string, expiry time.Duration) RedisLock

Variables

var Config = struct {
	DeadlockTimeout time.Duration
	StackDepth      int
}{
	DeadlockTimeout: time.Second * 10,
	StackDepth:      50,
}

Types

type ConsulLock

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

func (*ConsulLock) Lock

func (l *ConsulLock) Lock(ctx context.Context) (chan struct{}, error)

func (*ConsulLock) Unlock

func (l *ConsulLock) Unlock(ctx context.Context) error

func (*ConsulLock) WaitForUnlock

func (l *ConsulLock) WaitForUnlock(ctx context.Context) error

type ConsulLockPool

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

func NewConsulLockPool

func NewConsulLockPool(consulAddress string) (ConsulLockPool, error)

func (ConsulLockPool) NewLock

func (p ConsulLockPool) NewLock(lockName string, expiry time.Duration) *ConsulLock

type CountDownLatch

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

CountDownLatch is the same as sync.WaitGroup but with the ability to wait with timeout

func NewCountDownLatch

func NewCountDownLatch() *CountDownLatch

NewCountDownLatch creates a new CountDownLatch

func (*CountDownLatch) Add

func (l *CountDownLatch) Add(delta int)

Add increases/decreases the countdown

func (*CountDownLatch) Close

func (l *CountDownLatch) Close()

Close closes the latch unblocking wait

func (*CountDownLatch) Counter

func (l *CountDownLatch) Counter() int

Counter returns the current count down number

func (*CountDownLatch) Done

func (l *CountDownLatch) Done()

Done decreases the countdown by one

func (*CountDownLatch) Wait

func (l *CountDownLatch) Wait() <-chan struct{}

Wait to be unblocked

func (*CountDownLatch) WaitWithTimeout

func (l *CountDownLatch) WaitWithTimeout(timeout time.Duration) bool

WaitWithTimeout waits until the timeout runs out or until the countdown is zero

type Latch

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

Latch reusable lock that uses a channel to wait for the release of the lock

func NewLatch

func NewLatch() *Latch

NewLatch creates a new LockerChan

func (*Latch) Lock

func (c *Latch) Lock()

Lock locks the release of wait

func (*Latch) Unlock

func (c *Latch) Unlock()

Unlock releases the lock

func (*Latch) Wait

func (c *Latch) Wait() <-chan struct{}

Wait wait for the lock to be released

type Mutex

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

func (*Mutex) Lock

func (m *Mutex) Lock()

func (*Mutex) Unlock

func (m *Mutex) Unlock()

type RWMutex

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

func (*RWMutex) Lock

func (m *RWMutex) Lock()

func (*RWMutex) RLock

func (m *RWMutex) RLock()

func (*RWMutex) RUnlock

func (m *RWMutex) RUnlock()

func (*RWMutex) Unlock

func (m *RWMutex) Unlock()

type RedisLock

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

func (RedisLock) Lock

func (l RedisLock) Lock() (chan struct{}, error)

func (RedisLock) Unlock

func (l RedisLock) Unlock() error

type RedisLockPool

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

func NewRedisLockPool

func NewRedisLockPool(redisAddresses []string) (RedisLockPool, error)

func (RedisLockPool) NewLock

func (p RedisLockPool) NewLock(lockName string, expiry time.Duration) RedisLock