ksync

README

ksync

• Synchronization primitive that allows locking individual resources by unique Key.

Documentation

Index

• type Kcond
  • func DefaultKcond() *Kcond
  • func NewKcond(conf ...KcondConf) *Kcond
  • func (k *Kcond) Broadcast(key any)
  • func (k *Kcond) Lock(key any)
  • func (k *Kcond) Signal(key any)
  • func (k *Kcond) Unlock(key any)
  • func (k *Kcond) Wait(key any)
• type KcondConf
  • func WithKcondLocker(new func() sync.Locker) KcondConf
• type Kmutex
  • func DefaultKmutex() *Kmutex
  • func NewKmutex(conf ...KmutexConf) *Kmutex
  • func NewKspin() *Kmutex
  • func (k *Kmutex) Lock(key any)
  • func (k *Kmutex) TryLock(key any) (ok bool)
  • func (k *Kmutex) Unlock(key any)
• type KmutexConf
  • func WithKmutexLocker(new func() Mutex) KmutexConf
• type Krwmutex
  • func DefaultKrwmutex() *Krwmutex
  • func NewKrwmutex(conf ...KrwmutexConf) *Krwmutex
  • func (k *Krwmutex) Lock(key any)
  • func (k *Krwmutex) RLock(key any)
  • func (k *Krwmutex) RLocker(key any) sync.Locker
  • func (k *Krwmutex) RUnlock(key any)
  • func (k *Krwmutex) TryLock(key any) (ok bool)
  • func (k *Krwmutex) TryRLock(key any) (ok bool)
  • func (k *Krwmutex) Unlock(key any)
• type KrwmutexConf
  • func WithKrwmutexLocker(new func() RWMutex) KrwmutexConf
• type Mutex
• type RWMutex
• type Spin
  • func NewSpin() *Spin
  • func (s *Spin) Lock()
  • func (s *Spin) TryLock() bool
  • func (s *Spin) Unlock()

Types

type Kcond

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

func DefaultKcond

func DefaultKcond() *Kcond

func NewKcond

func NewKcond(conf ...KcondConf) *Kcond

func (*Kcond) Broadcast

func (k *Kcond) Broadcast(key any)

func (*Kcond) Lock

func (k *Kcond) Lock(key any)

func (*Kcond) Signal

func (k *Kcond) Signal(key any)

func (*Kcond) Unlock

func (k *Kcond) Unlock(key any)

func (*Kcond) Wait

func (k *Kcond) Wait(key any)

type KcondConf

type KcondConf func(*Kcond)

func WithKcondLocker

func WithKcondLocker(new func() sync.Locker) KcondConf

type Kmutex

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

func DefaultKmutex

func DefaultKmutex() *Kmutex

func NewKmutex

func NewKmutex(conf ...KmutexConf) *Kmutex

func NewKspin

func NewKspin() *Kmutex

func (*Kmutex) Lock

func (k *Kmutex) Lock(key any)

func (*Kmutex) TryLock

func (k *Kmutex) TryLock(key any) (ok bool)

func (*Kmutex) Unlock

func (k *Kmutex) Unlock(key any)

type KmutexConf

type KmutexConf func(*Kmutex)

func WithKmutexLocker

func WithKmutexLocker(new func() Mutex) KmutexConf

type Krwmutex

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

func DefaultKrwmutex

func DefaultKrwmutex() *Krwmutex

func NewKrwmutex

func NewKrwmutex(conf ...KrwmutexConf) *Krwmutex

func (*Krwmutex) Lock

func (k *Krwmutex) Lock(key any)

func (*Krwmutex) RLock

func (k *Krwmutex) RLock(key any)

func (*Krwmutex) RLocker

func (k *Krwmutex) RLocker(key any) sync.Locker

func (*Krwmutex) RUnlock

func (k *Krwmutex) RUnlock(key any)

func (*Krwmutex) TryLock

func (k *Krwmutex) TryLock(key any) (ok bool)

func (*Krwmutex) TryRLock

func (k *Krwmutex) TryRLock(key any) (ok bool)

func (*Krwmutex) Unlock

func (k *Krwmutex) Unlock(key any)

type KrwmutexConf

type KrwmutexConf func(*Krwmutex)

func WithKrwmutexLocker

func WithKrwmutexLocker(new func() RWMutex) KrwmutexConf

type Mutex

type Mutex interface {
	Lock()
	TryLock() bool
	Unlock()
}

type RWMutex

type RWMutex interface {
	Lock()
	RLock()
	RLocker() sync.Locker
	RUnlock()
	TryLock() bool
	TryRLock() bool
	Unlock()
}

type Spin

type Spin int32

func NewSpin

func NewSpin() *Spin

func (*Spin) Lock

func (s *Spin) Lock()

func (*Spin) TryLock

func (s *Spin) TryLock() bool

func (*Spin) Unlock

func (s *Spin) Unlock()