astilimiter

Documentation

Index

• type Bucket
  • func (b *Bucket) Inc() bool
• type Limiter
  • func New() *Limiter
  • func (l *Limiter) Add(name string, cap int, period time.Duration) *Bucket
  • func (l *Limiter) Bucket(name string) (b *Bucket, ok bool)

Types

type Bucket

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

Bucket represents a bucket

func (*Bucket) Inc

func (b *Bucket) Inc() bool

Inc increments the bucket count

type Limiter

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

Limiter represents a limiter

func New

func New() *Limiter

New creates a new limiter

func (*Limiter) Add

func (l *Limiter) Add(name string, cap int, period time.Duration) *Bucket

Add adds a new bucket

func (*Limiter) Bucket

func (l *Limiter) Bucket(name string) (b *Bucket, ok bool)

Bucket retrieves a bucket from the limiter