semaphores

Documentation

Overview

Package semaphores provides a go implementation of binary and counting semaphores. The underlying implementation is built on the channel primitive for goroutine notifications and atomic operations for for the fast path.

Index

• type Semaphore
  • func MakeBinarySemaphore(full bool) Semaphore
  • func MakeCountingSemaphore(initial int32, max int32) Semaphore

Types

type Semaphore

type Semaphore interface {
	// Take (decrement) a semaphore.  Routine will block until the semaphore is available.
	Take()

	// Take (decrement) a semaphore.  Routine will block until the timeout has occurred
	// or the semaphore becomes available
	TryTake(timeout time.Duration) bool

	// Release (increment) the semaphore.  Returns false if semaphore is signal.
	Give() bool

	// Test if the semaphore is signal.
	IsFull() bool

	// Test if the semaphore is empty.
	IsEmpty() bool

	//  Returns the count of a semaphore.
	Count() int32
}

Semaphore interface.

func MakeBinarySemaphore

func MakeBinarySemaphore(full bool) Semaphore

Create a binary semaphore. The semaphore can be initialized to 'up' (signal) or 'down'.

func MakeCountingSemaphore

func MakeCountingSemaphore(initial int32, max int32) Semaphore

Create a counting semaphore. The give operation increments the semaphore. A take operation decrements the semaphore.