v1

Documentation

Overview

Package v1 contains interface definitions for v1API

Index

• type RepoInterface
• type Request
• type Result
• type State
• type Strategy
• type UseCaseInterface

Types

type RepoInterface

type RepoInterface interface {
	RegisterClient(models.Client) (models.Client, error)
	GetClient(name string) (models.Client, error)
	UpdateClient(models.Client) error
	DeleteClient(name string) error
}

RepoInterface defines an interface for repository of v1API

type Request

type Request struct {
	Key      string
	Limit    uint64
	Duration time.Duration
}

Request struct defines a rate limit check request

type Result

type Result struct {
	State         State
	TotalRequests uint64
	ExpiresAt     time.Time
}

Result struct defines a rate limit check result

type State

type State int64

State defines the rate limiter state

const (
	Deny  State = 0
	Allow       = 1
)

Define constants for rate limit state

type Strategy

type Strategy interface {
	Run(r *Request) (*Result, error)
}

Strategy is an interface for rate limiting algorithms. Any rate limiting algorithm that implements this interface can be used with fluxy

type UseCaseInterface

type UseCaseInterface interface {
	RegisterClient(models.Client) (models.Client, error)
	GetClient(name string) (models.Client, error)
	UpdateClient(models.Client) error
	DeleteClient(name string) error
	VerifyLimit(name string) (*Result, error)
}

UseCaseInterface defines the logic interface of v1API