limiter

Documentation

Overview

Package limiter - Rate Limit 처리용 TokenBucket 구현 패키지

Index

• type TokenBucket
  • func NewTokenBucket(capacity int) *TokenBucket
  • func NewTokenBucketWithFill(capacity int, fillInterval int, fillTokens int) *TokenBucket
  • func (tb *TokenBucket) Dispose()
  • func (tb *TokenBucket) TryAquire() bool
  • func (tb *TokenBucket) TryAquireWithNum(num int) bool
  • func (tb *TokenBucket) WaitUntilAquire() bool
  • func (tb *TokenBucket) WaitUntilAquireWithNum(num int) bool

Types

type TokenBucket

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

TokenBucket - Ratelimit 처리를 위한 Token Bucket 형식

func NewTokenBucket

func NewTokenBucket(capacity int) *TokenBucket

NewTokenBucket - 지정한 허용 수 기준으로 TockenBucket 생성 (채워지는 기간과 수량은 기본값 사용) @param capacity: 초당 허용 수

func NewTokenBucketWithFill

func NewTokenBucketWithFill(capacity int, fillInterval int, fillTokens int) *TokenBucket

NewTokenBucket - 지정한 정보에 따라서 TokenBucket 생성 @param capacity: 초당 허용 수 @param fillInterval: 토큰을 채울 기간 (millisecond) @param fillTokens: 채울 토큰 수

func (*TokenBucket) Dispose

func (tb *TokenBucket) Dispose()

Dispose - TokenBucket을 채우는 처리 중지

func (*TokenBucket) TryAquire

func (tb *TokenBucket) TryAquire() bool

TryAquire - 사용할 Token획득 시도

func (*TokenBucket) TryAquireWithNum

func (tb *TokenBucket) TryAquireWithNum(num int) bool

TryAquireWithNum - 지정한 수만큼의 Token 획득 시도 @param num: 사용할 Token 요청 수

func (*TokenBucket) WaitUntilAquire

func (tb *TokenBucket) WaitUntilAquire() bool

WaitUntilAquire - 사용할 Token이 채워질 때까지 대기

func (*TokenBucket) WaitUntilAquireWithNum

func (tb *TokenBucket) WaitUntilAquireWithNum(num int) bool

WaitUntilAquireWithNum - 지정한 수만큼의 Token이 채워질때까지 대기 @param num: 사용할 Token 요청 수