limit

Documentation

Index

• Variables
• type Limiter
  • func NewLimiter(initLimit int64) (l *Limiter)
  • func (l *Limiter) Acquire(timeout time.Duration) (err error)
  • func (l *Limiter) Close()
  • func (l *Limiter) LimitNum() int64
  • func (l *Limiter) Release()
  • func (l *Limiter) RunningNum() int64
  • func (l *Limiter) SetLimit(num int64)
  • func (l *Limiter) WaitingNum() int64

Variables

var (
	ErrTimeout = errors.New("limiter acquire timeout")
	ErrClosed  = errors.New("limiter closed")
)

Types

type Limiter

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

Limiter support update limit number dynamically

func NewLimiter

func NewLimiter(initLimit int64) (l *Limiter)

func (*Limiter) Acquire

func (l *Limiter) Acquire(timeout time.Duration) (err error)

Acquire will wait for an available resource. timeout eq 0 means no timeout limit. Return ErrTimeout if no resource available after timeout duration. Return ErrClosed if this Limiter is closed.

func (*Limiter) Close

func (l *Limiter) Close()

func (*Limiter) LimitNum

func (l *Limiter) LimitNum() int64

func (*Limiter) Release

func (l *Limiter) Release()

Release resources.

func (*Limiter) RunningNum

func (l *Limiter) RunningNum() int64

func (*Limiter) SetLimit

func (l *Limiter) SetLimit(num int64)

func (*Limiter) WaitingNum

func (l *Limiter) WaitingNum() int64