http

Documentation

Index

• type IPAddress
• type IPRateLimiter
  • func NewIPRateLimiter(tps rate.Limit, size int) *IPRateLimiter
  • func (ipLimiter *IPRateLimiter) AddLimiter(ipAddr string) *rate.Limiter
  • func (ipLimiter *IPRateLimiter) GetLimiter(ipAddr string) *rate.Limiter
• type IPWhiteList
  • func NewIPWhiteList(ipList []string) (*IPWhiteList, error)
• type Server
  • func NewServer(version string, keys *auth.Keys, config *config.Service) (*Server, error)
  • func (ws *Server) Start() error

Types

type IPAddress

type IPAddress string

IPAddress represents an IP address string.

type IPRateLimiter

type IPRateLimiter struct {
	sync.Mutex
	// contains filtered or unexported fields
}

IPRateLimiter represents a rate limiter based on an IP address.

func NewIPRateLimiter

func NewIPRateLimiter(tps rate.Limit, size int) *IPRateLimiter

NewIPRateLimiter returns a new IPRateLimiter.

func (*IPRateLimiter) AddLimiter

func (ipLimiter *IPRateLimiter) AddLimiter(ipAddr string) *rate.Limiter

AddLimiter creates a new rate limiter and adds it to the limiters map, using the IP address as the key.

func (*IPRateLimiter) GetLimiter

func (ipLimiter *IPRateLimiter) GetLimiter(ipAddr string) *rate.Limiter

GetLimiter returns the rate limiter for the provided IP address if it exists. Otherwise calls AddLimiter to add a new limiter to the map.

type IPWhiteList

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

IPWhiteList contains white list information for rate limiting.

func NewIPWhiteList

func NewIPWhiteList(ipList []string) (*IPWhiteList, error)

NewIPWhiteList builds a new IPWhiteList from the list of IPs.

type Server

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

Server represents the entry point to interact with the service via HTTP requests.

func NewServer

func NewServer(version string, keys *auth.Keys, config *config.Service) (*Server, error)

NewServer returns a new instance of Server.

func (*Server) Start

func (ws *Server) Start() error

Start initiates the HTTP server.