nlock

Documentation

Overview

Package nlock provides a lock that can be locked n times simultaneously.

Deprecated: this can be implemented using a channel with n items.

Index

• type NLock
  • func New(n int) *NLock
  • func (n *NLock) Lock()
  • func (n *NLock) TryLock() bool
  • func (n *NLock) Unlock()

Types

type NLock

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

An NLock is a lock that allows n holders to hold the lock simultaneously.

func New

func New(n int) *NLock

New creates a new lock for n maximum holders.

func (*NLock) Lock

func (n *NLock) Lock()

Lock locks the lock. Will block if n calls to lock were made, that were not unlocked.

func (*NLock) TryLock

func (n *NLock) TryLock() bool

TryLock attempts to obtain lock without waiting. Returns true if succeeded, or false if not.

func (*NLock) Unlock

func (n *NLock) Unlock()

Unlock releases one holder of the lock. Panics if lock has 0 holders.