counter

README

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

Реализует интерфейс Counter, который доступен в контейнере объектов.

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

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

type Config struct {
	NumberAttempts uint16
}

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

Поле	Описание	Значение по умолчанию
NumberAttempts	Максимальное кол. попыток переподключения, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --client.socket.monitor.reconnect.number_attempts - переменная окружения CLIENT_SOCKET_MONITOR_RECONNECT_NUMBER_ATTEMPTS - значение в конфиг файле client.socket.monitor.reconnect.number_attempts	0

Если параметр NumberAttempts равен 0, то кол. попыток переключения будет безлимитное.

Documentation

Index

• Constants
• Variables
• type Config
  • func Configuration(config *Config, configurator configurator.Configurator) *Config
  • func NewConfig() *Config
• type Counter
  • func New(config *Config, informer logger.Informer) Counter
  • func NewWithConfigurator(config *Config, configurator configurator.Configurator, ...) Counter
• type Limit
  • func NewLimit(maximumAmount uint16) *Limit
  • func (counter *Limit) Next() bool
  • func (counter *Limit) Reset()
• type Unlimited
  • func NewUnlimited() *Unlimited
  • func (counter *Unlimited) Next() bool
  • func (counter *Unlimited) Reset()

Constants

const (
	NumberAttemptsFieldName = "client.socket.monitor.reconnect.number_attempts"

	NumberAttemptsDefault = uint16(0)
)

Variables

var Component = &app.Component{
	Constructor: func(container container.Container) error {
		return container.Provides(
			NewConfig,
			NewWithConfigurator,
		)
	},
	BindFlags: func(flagSet *pflag.FlagSet, container container.Container) error {
		return container.Invoke(func(config *Config) {
			flagSet.Uint16Var(
				&config.NumberAttempts,
				NumberAttemptsFieldName,
				NumberAttemptsDefault,
				"maximum number of switching attempts",
			)
		})
	},
}

Types

type Config

type Config struct {
	NumberAttempts uint16
}

func Configuration

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

func NewConfig

func NewConfig() *Config

type Counter

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

func New

func New(config *Config, informer logger.Informer) Counter

func NewWithConfigurator

func NewWithConfigurator(config *Config, configurator configurator.Configurator, informer logger.Informer) Counter

type Limit

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

func NewLimit

func NewLimit(maximumAmount uint16) *Limit

func (*Limit) Next

func (counter *Limit) Next() bool

func (*Limit) Reset

func (counter *Limit) Reset()

type Unlimited

type Unlimited struct{}

func NewUnlimited

func NewUnlimited() *Unlimited

func (*Unlimited) Next

func (counter *Unlimited) Next() bool

func (*Unlimited) Reset

func (counter *Unlimited) Reset()