mutex

Documentation

Overview

Package mutex implements the sync.Locker interface using x/sync/semaphore. It may be used as a replacement for sync.Mutex when one or more goroutines need to allow their calls to Lock to be cancelled by context cancellation.

Index

• type Mutex
  • func New() *Mutex
  • func (m *Mutex) Lock()
  • func (m *Mutex) TryLock(ctx context.Context) error
  • func (m *Mutex) Unlock()

Types

type Mutex

type Mutex semaphore.Weighted

func New

func New() *Mutex

New returns a Mutex that is ready for use.

func (*Mutex) Lock

func (m *Mutex) Lock()

func (*Mutex) TryLock

func (m *Mutex) TryLock(ctx context.Context) error

TryLock acquires the mutex, blocking until resources are available or ctx is done. On success, returns nil. On failure, returns ctx.Err() and leaves the semaphore unchanged.

If ctx is already done, Acquire may still succeed without blocking.

func (*Mutex) Unlock

func (m *Mutex) Unlock()