internal

Documentation

Index

• func NewLogger(config *api.EquinoxConfig) *zap.SugaredLogger
• func NewTestEquinoxConfig() *api.EquinoxConfig
• type Cache
  • func NewCache(ttl int) (*Cache, error)
  • func (c *Cache) Clear() error
  • func (c *Cache) Get(url string) []byte
  • func (c *Cache) Set(url string, res []byte) error
• type InternalClient
  • func NewInternalClient(config *api.EquinoxConfig) (*InternalClient, error)
  • func (c *InternalClient) ClearInternalClientCache() error
  • func (c *InternalClient) Get(route interface{}, endpoint string, object interface{}, endpointName string, ...) error
  • func (c *InternalClient) Logger(client string, endpoint string, method string) *zap.SugaredLogger
  • func (c *InternalClient) Post(route interface{}, endpoint string, requestBody interface{}, ...) error
  • func (c *InternalClient) Put(route interface{}, endpoint string, requestBody interface{}, ...) error
• type Methods
• type Rate
  • func ParseHeaders(headers http.Header, limitHeader string, countHeader string) *Rate
• type RateLimit
  • func NewRateLimit() *RateLimit
  • func (r *RateLimit) Get(endpointName string, methodName string) *Rate
  • func (r *RateLimit) IsRateLimited(rate *Rate) bool
  • func (r *RateLimit) Set(endpointName string, methodName string, rate *Rate)
  • func (r *RateLimit) SetAppRate(rate *Rate)
• type RateTiming

Functions

func NewLogger

func NewLogger(config *api.EquinoxConfig) *zap.SugaredLogger

Creates a new zap.Logger from the configuration parameters provided.

func NewTestEquinoxConfig

func NewTestEquinoxConfig() *api.EquinoxConfig

Creates an EquinoxConfig for tests.

Types

type Cache

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

func NewCache

func NewCache(ttl int) (*Cache, error)

func (*Cache) Clear

func (c *Cache) Clear() error

Clears the cache

func (*Cache) Get

func (c *Cache) Get(url string) []byte

Gets item from the cache

func (*Cache) Set

func (c *Cache) Set(url string, res []byte) error

Adds an item in the cache

type InternalClient

type InternalClient struct {
	Cluster api.Cluster
	// contains filtered or unexported fields
}

func NewInternalClient

func NewInternalClient(config *api.EquinoxConfig) (*InternalClient, error)

Returns a new InternalClient using configuration object provided.

func (*InternalClient) ClearInternalClientCache

func (c *InternalClient) ClearInternalClientCache() error

func (*InternalClient) Get

func (c *InternalClient) Get(route interface{}, endpoint string, object interface{}, endpointName string, method string, authorizationHeader string) error

Performs a GET request, authorizationHeader can be blank

func (*InternalClient) Logger

func (c *InternalClient) Logger(client string, endpoint string, method string) *zap.SugaredLogger

Used to access the logger from the InternalClient, this is used to log events from other clients (RiotClient, LOLClient...)

func (*InternalClient) Post

func (c *InternalClient) Post(route interface{}, endpoint string, requestBody interface{}, object interface{}, endpointName string, method string, authorizationHeader string) error

Performs a POST request, authorizationHeader can be blank

func (*InternalClient) Put

func (c *InternalClient) Put(route interface{}, endpoint string, requestBody interface{}, endpointName string, method string) error

Performs a PUT request

type Methods

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

type Rate

type Rate struct {
	Seconds *RateTiming
	Minutes *RateTiming
}

func ParseHeaders

func ParseHeaders(headers http.Header, limitHeader string, countHeader string) *Rate

type RateLimit

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

func NewRateLimit

func NewRateLimit() *RateLimit

func (*RateLimit) Get

func (r *RateLimit) Get(endpointName string, methodName string) *Rate

func (*RateLimit) IsRateLimited

func (r *RateLimit) IsRateLimited(rate *Rate) bool

Checks if the *Rate is currently rate limited

func (*RateLimit) Set

func (r *RateLimit) Set(endpointName string, methodName string, rate *Rate)

func (*RateLimit) SetAppRate

func (r *RateLimit) SetAppRate(rate *Rate)

type RateTiming

type RateTiming struct {
	// The amount in seconds the rate limit should reset
	Time int
	// Maximum amount of requests in n seconds
	Limit int
	// Current count of requests made in n seconds
	Count int

	Ticker *time.Ticker
	Mutex  *sync.Mutex
}