leakybucket

Documentation

Overview

Reference uber ratelimit, the different is support no wait take func

Package leakybucket is a generated GoMock package.

Index

• func NewLimiter() *leakyBucketLimiter
• type LeakyBucket
  • func NewLeakyBucket(rate, volume int, opts ...Option) LeakyBucket
• type MockLeakyBucket
  • func NewMockLeakyBucket(ctrl *gomock.Controller) *MockLeakyBucket
  • func (m *MockLeakyBucket) Allow() bool
  • func (m *MockLeakyBucket) EXPECT() *MockLeakyBucketMockRecorder
  • func (m *MockLeakyBucket) SetRate(rate int)
  • func (m *MockLeakyBucket) SetVolume(volume int)
• type MockLeakyBucketMockRecorder
  • func (mr *MockLeakyBucketMockRecorder) Allow() *gomock.Call
  • func (mr *MockLeakyBucketMockRecorder) SetRate(rate interface{}) *gomock.Call
  • func (mr *MockLeakyBucketMockRecorder) SetVolume(volume interface{}) *gomock.Call
• type Option
  • func WithClock(clock clock.Clock) Option
  • func WithPer(per time.Duration) Option

Functions

func NewLimiter

func NewLimiter() *leakyBucketLimiter

Types

type LeakyBucket

type LeakyBucket interface {
	Allow() bool
	SetRate(rate int)
	SetVolume(volume int)
}

func NewLeakyBucket

func NewLeakyBucket(rate, volume int, opts ...Option) LeakyBucket

type MockLeakyBucket

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

MockLeakyBucket is a mock of LeakyBucket interface.

func NewMockLeakyBucket

func NewMockLeakyBucket(ctrl *gomock.Controller) *MockLeakyBucket

NewMockLeakyBucket creates a new mock instance.

func (*MockLeakyBucket) Allow

func (m *MockLeakyBucket) Allow() bool

Allow mocks base method.

func (*MockLeakyBucket) EXPECT

func (m *MockLeakyBucket) EXPECT() *MockLeakyBucketMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockLeakyBucket) SetRate

func (m *MockLeakyBucket) SetRate(rate int)

SetRate mocks base method.

func (*MockLeakyBucket) SetVolume

func (m *MockLeakyBucket) SetVolume(volume int)

SetVolume mocks base method.

type MockLeakyBucketMockRecorder

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

MockLeakyBucketMockRecorder is the mock recorder for MockLeakyBucket.

func (*MockLeakyBucketMockRecorder) Allow

func (mr *MockLeakyBucketMockRecorder) Allow() *gomock.Call

Allow indicates an expected call of Allow.

func (*MockLeakyBucketMockRecorder) SetRate

func (mr *MockLeakyBucketMockRecorder) SetRate(rate interface{}) *gomock.Call

SetRate indicates an expected call of SetRate.

func (*MockLeakyBucketMockRecorder) SetVolume

func (mr *MockLeakyBucketMockRecorder) SetVolume(volume interface{}) *gomock.Call

SetVolume indicates an expected call of SetVolume.

type Option

type Option func(o *option)

func WithClock

func WithClock(clock clock.Clock) Option

func WithPer

func WithPer(per time.Duration) Option