limiter

README

Счтечик попыток переподключения.

Вспомогательный компонент который считает количество попыток переподклчится к БД.

Объект конфигурации.

type Config struct {
    ReConnectionLimit uint16
}

Описание полей:

Поле	Описание	Значение по умолчанию
ReConnectionLimit	Ограничение количества попыток переключения, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --db.re_connection.limit - переменная окружения DB_RE_CONNECTION.LIMIT - значение в конфиг файле db.re_connection.limit	10

Если значение ReConnectionLimit равно 0, то количество попыток переключения не ограничено.

Интерфейс счетчика

type Limiter interface {
	Next() bool
	Reset()
}

Методы:

• Next - увеличивает внутренний счетчик на 1 и возвращает true, если счетчик еще не дошел до лимита, в противном случае возвращает false;
• Reset - сбрасывает счетчик на 0.

Documentation

Index

• Constants
• Variables
• type Config
  • func Configuration(config *Config, configurator configurator.Configurator) *Config
  • func NewConfig() *Config
• type Limit
  • func NewLimit(config *Config) *Limit
  • func (limier *Limit) Next() bool
  • func (limier *Limit) Reset()
• type Limiter
  • func New(config *Config) Limiter
• type ReConfiguration
  • func NewReConfiguration(logger logger.Logger, config *Config) *ReConfiguration
  • func NewReConfigurationWithConfigurator(logger logger.Logger, config *Config, configurator configurator.Configurator) *ReConfiguration
  • func (reConfiguration *ReConfiguration) Limiter() Limiter
  • func (reConfiguration *ReConfiguration) Next() bool
  • func (reConfiguration *ReConfiguration) ReConfiguration(configurator configurator.Configurator) error
  • func (reConfiguration *ReConfiguration) Reset()
• type UnLimit
  • func NewUnLimit() *UnLimit
  • func (limiter *UnLimit) Next() bool
  • func (limiter *UnLimit) Reset()

Constants

const (
	ReConnectionLimitFieldName = "db.re_connection.limit"

	ReConnectionLimitDefault = uint16(10)
)

Variables

var Component = &app.Component{
	Dependencies: app.Components{
		logger.Component,
		configurator.Component,
		reConfiguration.Component,
	},
	Constructor: app.Constructor(func(container container.Container) error {
		return container.Provides(
			NewConfig,
			NewReConfigurationWithConfigurator,
			func(reConfiguration *ReConfiguration) Limiter { return reConfiguration },
		)
	}),
	BindFlags: app.BindFlags(func(flagSet *pflag.FlagSet, container container.Container) error {
		return container.Invoke(func(config *Config) {
			flagSet.Uint16Var(
				&config.ReConnectionLimit,
				ReConnectionLimitFieldName,
				ReConnectionLimitDefault,
				"the maximum number of reconnection attempts, if 0 then unlimited",
			)
		})
	}),
	Run: app.Run(func(container container.Container) error {
		return container.Invoke(func(
			limiter *ReConfiguration,
			reConfiguration reConfiguration.ReConfiguration,
			informer logger.Informer,
			config *Config,
		) {
			reConfiguration.Registration(limiter)
			informer.Info("data_base.limiter: registration in the reConfigurator")
		})
	}),
}

Types

type Config

type Config struct {
	ReConnectionLimit uint16
}

func Configuration

func Configuration(config *Config, configurator configurator.Configurator) *Config

func NewConfig

func NewConfig() *Config

type Limit

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

func NewLimit

func NewLimit(config *Config) *Limit

func (*Limit) Next

func (limier *Limit) Next() bool

func (*Limit) Reset

func (limier *Limit) Reset()

type Limiter

type Limiter interface {
	Next() bool
	Reset()
}

func New

func New(config *Config) Limiter

type ReConfiguration

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

func NewReConfiguration

func NewReConfiguration(logger logger.Logger, config *Config) *ReConfiguration

func NewReConfigurationWithConfigurator

func NewReConfigurationWithConfigurator(logger logger.Logger, config *Config, configurator configurator.Configurator) *ReConfiguration

func (*ReConfiguration) Limiter

func (reConfiguration *ReConfiguration) Limiter() Limiter

func (*ReConfiguration) Next

func (reConfiguration *ReConfiguration) Next() bool

func (*ReConfiguration) ReConfiguration

func (reConfiguration *ReConfiguration) ReConfiguration(configurator configurator.Configurator) error

func (*ReConfiguration) Reset

func (reConfiguration *ReConfiguration) Reset()

type UnLimit

type UnLimit struct{}

func NewUnLimit

func NewUnLimit() *UnLimit

func (*UnLimit) Next

func (limiter *UnLimit) Next() bool

func (*UnLimit) Reset

func (limiter *UnLimit) Reset()