throttling

Documentation

Index

• type Throttler
  • func NewThrottler(perSecond uint) *Throttler
  • func (throttler *Throttler) RequestTicket()
  • func (throttler *Throttler) ReturnUnusedTicket()
  • func (throttler *Throttler) TearDown()
  • func (throttler *Throttler) UseTicket()

Types

type Throttler

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

func NewThrottler

func NewThrottler(perSecond uint) *Throttler

Returns a new Throttler, which allows the retrival of up to perSecond tickets per second.

After a waiting for a ticket the ticket has either to be returned or used

func (*Throttler) RequestTicket

func (throttler *Throttler) RequestTicket()

Blocks until a ticket is available. Afterwards either ReturnUnusedTicket() or UseTicket has to be called.

func (*Throttler) ReturnUnusedTicket

func (throttler *Throttler) ReturnUnusedTicket()

func (*Throttler) TearDown

func (throttler *Throttler) TearDown()

Tears down the throttler. It is the callers responsibility that no thread is in RequestTicket(). Whether the threads in RequestTicket() are woken up or not is completely undefined.

func (*Throttler) UseTicket

func (throttler *Throttler) UseTicket()

This function has to be called when actually using a requested ticket, otherwise no new ticket will be generated.