gothrottle

package module

Go to main page

Versions in this module

v1

v1.1.0

Sep 2, 2026

Changes in this version

+ var ErrInvalidID = errors.New("limiter ID is invalid")

+ var ErrInvalidLeaseTTL = errors.New("LeaseTTL must not be negative")

+ var ErrInvalidMaxConcurrent = errors.New("MaxConcurrent must not be negative")

+ var ErrInvalidMaxQueueSize = errors.New("MaxQueueSize must not be negative")

+ var ErrInvalidMinTime = errors.New("MinTime must not be negative")

+ var ErrInvalidRetryInterval = errors.New("RetryInterval must not be negative")

+ var ErrInvalidSchedPolicy = errors.New("SchedPolicy is not a known scheduling policy")

+ var ErrLeaseLost = errors.New("lease is no longer held")

+ var ErrLimiterConfigMismatch = errors.New(...)

+ var ErrNilClient error = nilClientError

+ var ErrNilLease = errors.New("lease must not be nil")

+ var ErrNilTask = errors.New("task must not be nil")

+ var ErrQueueFull = errors.New("limiter queue is full")

+ var ErrTaskPanic = errors.New("task panicked")

+ var ErrWeightExceedsMax = errors.New("job weight exceeds max concurrent limit")

+ func RedisStateKey(limiterID string) string

+ type Lease struct

+ ExpiresAt time.Time

+ LimiterID string

+ TTL time.Duration

+ Token string

+ Weight int

+ type LeaseDatastore interface

+ Acquire func(ctx context.Context, limiterID string, weight int, opts Options) (lease *Lease, retryAfter time.Duration, err error)

+ Release func(ctx context.Context, lease *Lease) error

+ Renew func(ctx context.Context, lease *Lease) error

type Limiter

+ func (l *Limiter) QueueLen() int

+ func (l *Limiter) Running() int

+ func (l *Limiter) ScheduleContext(ctx context.Context, task func() (interface{}, error)) (interface{}, error)

+ func (l *Limiter) ScheduleWithOptionsContext(ctx context.Context, task func() (interface{}, error), priority, weight int) (interface{}, error)

type LocalStore

+ func (ls *LocalStore) Acquire(_ context.Context, limiterID string, weight int, opts Options) (*Lease, time.Duration, error)

+ func (ls *LocalStore) Release(_ context.Context, lease *Lease) error

+ func (ls *LocalStore) Renew(_ context.Context, lease *Lease) error

type Options

+ CloseDatastoreOnStop bool

+ LeaseTTL time.Duration

+ MaxQueueSize int

+ OnError func(error)

+ RetryInterval time.Duration

+ SchedPolicy SchedPolicy

+ func (o Options) Validate() error

+ type PanicError struct

+ Stack []byte

+ Value interface{}

+ func (e *PanicError) Error() string

+ func (e *PanicError) Unwrap() error

type PriorityQueue

+ func (pq *PriorityQueue) Peek() *Job

+ func (pq *PriorityQueue) Remove(job *Job) bool

+ type RedisKeyLayout struct

+ Config string

+ Expirations string

+ LastStart string

+ Leases string

+ func RedisKeys(limiterID string) RedisKeyLayout

type RedisStore

+ func (rs *RedisStore) Acquire(ctx context.Context, limiterID string, weight int, opts Options) (*Lease, time.Duration, error)

+ func (rs *RedisStore) Close() error

+ func (rs *RedisStore) Release(ctx context.Context, lease *Lease) error

+ func (rs *RedisStore) Renew(ctx context.Context, lease *Lease) error

+ type SchedPolicy int

+ const SchedBestFit

+ const SchedStrict

v1.0.0

Jul 3, 2025

Changes in this version

+ var ErrInvalidWeight = errors.New("job weight must be positive")

+ var ErrMissingID = errors.New("limiter ID is required")

+ var ErrStoreClosed = errors.New("store is closed")

+ type Datastore interface

+ Disconnect func() error

+ RegisterDone func(limiterID string, weight int) error

+ Request func(limiterID string, weight int, opts Options) (canRun bool, waitTime time.Duration, err error)

+ type Job struct

+ Priority int

+ Task func() (interface{}, error)

+ Weight int

+ type Limiter struct

+ func NewLimiter(opts Options) (*Limiter, error)

+ func (l *Limiter) Schedule(task func() (interface{}, error)) (interface{}, error)

+ func (l *Limiter) ScheduleWithOptions(task func() (interface{}, error), priority, weight int) (interface{}, error)

+ func (l *Limiter) Stop() error

+ func (l *Limiter) Wrap(fn func() (interface{}, error)) func() (interface{}, error)

+ type LocalState struct

+ type LocalStore struct

+ func NewLocalStore() *LocalStore

+ func (ls *LocalStore) Disconnect() error

+ func (ls *LocalStore) RegisterDone(limiterID string, weight int) error

+ func (ls *LocalStore) Request(limiterID string, weight int, opts Options) (canRun bool, waitTime time.Duration, err error)

+ type Options struct

+ Datastore Datastore

+ ID string

+ MaxConcurrent int

+ MinTime time.Duration

+ type PriorityQueue []*Job

+ func NewPriorityQueue() *PriorityQueue

+ func (pq *PriorityQueue) IsEmpty() bool

+ func (pq *PriorityQueue) Pop() interface{}

+ func (pq *PriorityQueue) PopJob() *Job

+ func (pq *PriorityQueue) Push(x interface{})

+ func (pq *PriorityQueue) PushJob(job *Job)

+ func (pq PriorityQueue) Len() int

+ func (pq PriorityQueue) Less(i, j int) bool

+ func (pq PriorityQueue) Swap(i, j int)

+ type RedisStore struct

+ func NewRedisStore(client *redis.Client) (*RedisStore, error)

+ func (rs *RedisStore) Disconnect() error

+ func (rs *RedisStore) RegisterDone(limiterID string, weight int) error

+ func (rs *RedisStore) Request(limiterID string, weight int, opts Options) (canRun bool, waitTime time.Duration, err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL