csync

Documentation

Index

• type Mutex
  • func (m *Mutex) Lock(ctx context.Context) (func(), error)
  • func (m *Mutex) Locker() sync.Locker
  • func (m *Mutex) TryLock() (func(), bool)
• type MutexLocker
  • func (l *MutexLocker) Lock()
  • func (l *MutexLocker) Unlock()
• type RWMutex
  • func (m *RWMutex) Lock(ctx context.Context, write bool) (func(), error)
  • func (m *RWMutex) Locker() sync.Locker
  • func (m *RWMutex) RLocker() sync.Locker
  • func (m *RWMutex) TryLock(write bool) (func(), bool)
• type RWMutexLocker
  • func (l *RWMutexLocker) Lock()
  • func (l *RWMutexLocker) Unlock()

Types

type Mutex

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

Mutex implements a mutex with a Broadcast. Implements a mutex that accepts a Context. An empty value Mutex{} is valid.

func (*Mutex) Lock

func (m *Mutex) Lock(ctx context.Context) (func(), error)

Lock attempts to hold a lock on the Mutex. Returns a lock release function or an error.

func (*Mutex) Locker

func (m *Mutex) Locker() sync.Locker

Locker returns a MutexLocker that uses context.Background to lock the Mutex.

func (*Mutex) TryLock

func (m *Mutex) TryLock() (func(), bool)

TryLock attempts to hold a lock on the Mutex. Returns a lock release function or nil if the lock could not be grabbed.

type MutexLocker

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

MutexLocker implements Locker for a Mutex.

func (*MutexLocker) Lock

func (l *MutexLocker) Lock()

Lock implements the sync.Locker interface.

func (*MutexLocker) Unlock

func (l *MutexLocker) Unlock()

Unlock implements the sync.Locker interface.

type RWMutex

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

RWMutex implements a RWMutex with a Broadcast. Implements a RWMutex that accepts a Context. An empty value RWMutex{} is valid.

func (*RWMutex) Lock

func (m *RWMutex) Lock(ctx context.Context, write bool) (func(), error)

Lock attempts to hold a lock on the RWMutex. Returns a lock release function or an error. A single writer OR many readers can hold Lock at a time. If a writer is waiting to lock, readers will wait for it.

func (*RWMutex) Locker

func (m *RWMutex) Locker() sync.Locker

Locker returns an RWMutexLocker that uses context.Background to write lock the RWMutex.

func (*RWMutex) RLocker

func (m *RWMutex) RLocker() sync.Locker

RLocker returns an RWMutexLocker that uses context.Background to read lock the RWMutex.

func (*RWMutex) TryLock

func (m *RWMutex) TryLock(write bool) (func(), bool)

TryLock attempts to hold a lock on the RWMutex. Returns a lock release function or nil if the lock could not be grabbed. A single writer OR many readers can hold Lock at a time. If a writer is waiting to lock, readers will wait for it.

type RWMutexLocker

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

RWMutexLocker implements Locker for a RWMutex.

func (*RWMutexLocker) Lock

func (l *RWMutexLocker) Lock()

Lock implements the sync.Locker interface.

func (*RWMutexLocker) Unlock

func (l *RWMutexLocker) Unlock()

Unlock implements the sync.Locker interface.