utmost

README

go-utmost

limit the number of simultaneous goroutines, with some observability.

Documentation

Overview

Package utmost lets you limit the number of simultaneous goroutines, with some observability.

Index

• Constants
• type TicketsMachine
  • func New(limit int) *TicketsMachine
  • func (t *TicketsMachine) Dispensed() int
  • func (t *TicketsMachine) Go(goroutine func())
  • func (t *TicketsMachine) InUse() int
  • func (t *TicketsMachine) Limit() int
  • func (t *TicketsMachine) MaxInUse() int
  • func (t *TicketsMachine) Wait()

Constants

const (
	// DefaultUtmost is used if you ask a negative limit
	DefaultUtmost = 100
)

Types

type TicketsMachine

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

TicketsMachine is our base type

func New

func New(limit int) *TicketsMachine

New returns a initialized *TicketsMachine

func (*TicketsMachine) Dispensed

func (t *TicketsMachine) Dispensed() int

Dispensed returns the total number of dispensed tickets

func (*TicketsMachine) Go

func (t *TicketsMachine) Go(goroutine func())

Go executes your function as a goroutine, and blocks awaiting a free ticket if needed

func (*TicketsMachine) InUse

func (t *TicketsMachine) InUse() int

InUse returns the currently used tickets

func (*TicketsMachine) Limit

func (t *TicketsMachine) Limit() int

Limit returns the limit of simultaneous dispensed tickets

func (*TicketsMachine) MaxInUse

func (t *TicketsMachine) MaxInUse() int

MaxInUse returns the max simultaneous used tickets

func (*TicketsMachine) Wait

func (t *TicketsMachine) Wait()

Wait blocks until the WaitGroup counter is zero.