helper

Documentation

Index

• func SendAndSubstractUint32(metric string, v *uint32, send StatCallback)
• func SendAndSubstractUint64(metric string, v *uint64, send StatCallback)
• func SendAndZeroIfNotUpdatedUint32(metric string, v *uint32, send StatCallback)
• func SendUint32(metric string, v *uint32, send StatCallback)
• func SendUint64(metric string, v *uint64, send StatCallback)
• type StatCallback
• type Stoppable
  • func (s *Stoppable) Start()
  • func (s *Stoppable) StartFunc(startProcedure func() error) error
  • func (s *Stoppable) Stop()
  • func (s *Stoppable) StopFunc(callable func())
• type StoppableInterface
• type ThrottleTicker
  • func NewHardThrottleTicker(ratePerSec int) *ThrottleTicker
  • func NewThrottleTicker(ratePerSec int) *ThrottleTicker

Functions

func SendAndSubstractUint32

func SendAndSubstractUint32(metric string, v *uint32, send StatCallback)

func SendAndSubstractUint64

func SendAndSubstractUint64(metric string, v *uint64, send StatCallback)

func SendAndZeroIfNotUpdatedUint32

func SendAndZeroIfNotUpdatedUint32(metric string, v *uint32, send StatCallback)

func SendUint32

func SendUint32(metric string, v *uint32, send StatCallback)

func SendUint64

func SendUint64(metric string, v *uint64, send StatCallback)

Types

type StatCallback

type StatCallback func(metric string, value float64)

type Stoppable

type Stoppable struct {
	sync.RWMutex

	Go       func(callable func(exit chan bool))
	WithExit func(callable func(exit chan bool))
	// contains filtered or unexported fields
}

Stoppable is abstract class with Start/Stop methods

func (*Stoppable) Start

func (s *Stoppable) Start()

Start ...

func (*Stoppable) StartFunc

func (s *Stoppable) StartFunc(startProcedure func() error) error

StartFunc ...

func (*Stoppable) Stop

func (s *Stoppable) Stop()

Stop ...

func (*Stoppable) StopFunc

func (s *Stoppable) StopFunc(callable func())

StopFunc ...

type StoppableInterface

type StoppableInterface interface {
}

type ThrottleTicker

type ThrottleTicker struct {
	Stoppable
	C chan bool
}

ThrottleTicker is a ticker that can be used for hard or soft rate-limiting.

• A soft rate limiter will send a message on C at the actual rate that is specified.

• A hard rate limiter may send arbitrarily many messages on C every second, but it will send the value 'true' with the first ratePerSec ones, and 'false' with all subsequent ones, until the next second. It is up to the user to decide what to do in each case.

func NewHardThrottleTicker

func NewHardThrottleTicker(ratePerSec int) *ThrottleTicker

NewHardThrottleTicker returns a new hard throttle ticker.

func NewThrottleTicker

func NewThrottleTicker(ratePerSec int) *ThrottleTicker

NewThrottleTicker returns a new soft throttle ticker.