ratelimit

Documentation

Index

• type Config
• type Service
  • func New(g *run.Group, cfg *Config) *Service
  • func (s *Service) FlagSet() *run.FlagSet
  • func (s *Service) GracefulStop()
  • func (s *Service) Name() string
  • func (s *Service) PreRun() error
  • func (s *Service) Serve() (err error)
  • func (s *Service) Validate() error

Types

type Config

type Config struct {
	Logger         telemetry.Logger
	Settings       *settingsv1.Settings
	GenerateConfig func() (*settingsv1.Settings, error)
}

Config holds the configuration object for running the rate-limit service.

type Service

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

Service is a run.Service implementation that runs the rate-limit service.

func New

func New(g *run.Group, cfg *Config) *Service

New returns a new run.Service that wraps rate-limit service. Setting the cfg to nil, expecting setting the rate-limit settings object from a file.

func (*Service) FlagSet

func (s *Service) FlagSet() *run.FlagSet

FlagSet provides command line flags for the service.

func (*Service) GracefulStop

func (s *Service) GracefulStop()

GracefulStop stops the underlying process by sending interrupt.

func (*Service) Name

func (s *Service) Name() string

Name returns the service name.

func (*Service) PreRun

func (s *Service) PreRun() error

PreRun prepares the service to run.

func (*Service) Serve

func (s *Service) Serve() (err error)

Serve runs the service.

func (*Service) Validate

func (s *Service) Validate() error

Validate validates the given configuration.