zsync

Documentation

Index

• type Counter
  • func NewCounter() *Counter
  • func (c *Counter) Add(val int)
  • func (c *Counter) Set(val int)
  • func (c *Counter) WaitExactly(val int) <-chan bool
• type LockerMap
  • func NewLockerMap(capacity int) *LockerMap
  • func (m *LockerMap) Lock(key string) sync.Locker
  • func (m *LockerMap) Unlock(key string)
  • func (m *LockerMap) With(key string, cb func())
• type MaxLimiter
  • func NewMaxLimiter(max int) *MaxLimiter
  • func (l *MaxLimiter) Lock()
  • func (l *MaxLimiter) Unlock()
• type RWLockerMap
  • func NewRWLockerMap(capacity int) *RWLockerMap
  • func (m *RWLockerMap) Lock(key string) *sync.RWMutex
  • func (m *RWLockerMap) RLock(key string) *sync.RWMutex
  • func (m *RWLockerMap) RUnlock(key string)
  • func (m *RWLockerMap) RWith(key string, cb func())
  • func (m *RWLockerMap) Unlock(key string)
  • func (m *RWLockerMap) With(key string, cb func())

Types

type Counter

type Counter struct {
	Value int
	// contains filtered or unexported fields
}

func NewCounter

func NewCounter() *Counter

func (*Counter) Add

func (c *Counter) Add(val int)

func (*Counter) Set

func (c *Counter) Set(val int)

func (*Counter) WaitExactly

func (c *Counter) WaitExactly(val int) <-chan bool

type LockerMap

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

A LockerMap manages a map of sync.Mutex for safely accessing resources that are distinguished by a key

func NewLockerMap

func NewLockerMap(capacity int) *LockerMap

func (*LockerMap) Lock

func (m *LockerMap) Lock(key string) sync.Locker

Lock a resource. Calls sync.Mutex.Lock() for the mutex defined for this key.

func (*LockerMap) Unlock

func (m *LockerMap) Unlock(key string)

Unlock a resource that was locked. Calls sync.Mutex.Unlock() for the mutex defined for this key.

func (*LockerMap) With

func (m *LockerMap) With(key string, cb func())

Safely read/write a resource using a function

type MaxLimiter

type MaxLimiter struct {
	Active  int
	Pending int
	Max     int
	// contains filtered or unexported fields
}

func NewMaxLimiter

func NewMaxLimiter(max int) *MaxLimiter

Keep number of active locks below the Max count. Useful for limiting the number of goroutines running simultaneously

func (*MaxLimiter) Lock

func (l *MaxLimiter) Lock()

Lock will wait until Active < Max

func (*MaxLimiter) Unlock

func (l *MaxLimiter) Unlock()

Must call unlock when work is completed

type RWLockerMap

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

Create a map of sync.RWMutex

func NewRWLockerMap

func NewRWLockerMap(capacity int) *RWLockerMap

func (*RWLockerMap) Lock

func (m *RWLockerMap) Lock(key string) *sync.RWMutex

Lock a resource for reading. Calls sync.RWMutex.Lock on the mutex for this key.

func (*RWLockerMap) RLock

func (m *RWLockerMap) RLock(key string) *sync.RWMutex

Lock a resource for reading. Calls sync.RWMutex.RLock on the mutex for this key.

func (*RWLockerMap) RUnlock

func (m *RWLockerMap) RUnlock(key string)

Unlock a resource that was locked for reading. Calls sync.RWMutex.Unlock on the mutex for this key.

func (*RWLockerMap) RWith

func (m *RWLockerMap) RWith(key string, cb func())

Safely read from a resource using a function

func (*RWLockerMap) Unlock

func (m *RWLockerMap) Unlock(key string)

Unlock a resource that was locked for reading a writing. Calls sync.RWMutex.Unlock on the mutex for this key.

func (*RWLockerMap) With

func (m *RWLockerMap) With(key string, cb func())

Safely read/write a resource using a function