config

Documentation

Index

• Constants
• type Conf
  • func New() *Conf
  • func (c *Conf) Load(file string, fileType FileType) error
  • func (c *Conf) String() string
• type DelayQueue
• type FileType
• type Redis
• type RedisMode
  • func (r RedisMode) IsCluster() bool

Constants

const (
	// delay queue configuration
	DefaultDQBindAddress       = ":8000"
	DefaultDQBucketName        = "dq_bucket"
	DefaultDQQueueName         = "dq_queue"
	DefaultDQBucketSize        = 8
	DefaultDQBucketMaxFetchNum = 200
	DefaultTimerFetchInterval  = 10000
	DefaultFetchJobBlockTime   = 5

	// redis configuration
	DefaultRedisNetwork      = "tcp"
	DefaultRedisAddress      = "127.0.0.1:6379"
	DefaultRedisDialTimeout  = 5000
	DefaultRedisReadTimeout  = 3000
	DefaultRedisWriteTimeout = 3000
)

default configurations

Types

type Conf

type Conf struct {
	DelayQueue DelayQueue `yaml:"delay_queue,omitempty" json:"delay_queue,omitempty"`
	Redis      Redis      `yaml:"redis,omitempty" json:"redis,omitempty"`
}

Conf configuration

func New

func New() *Conf

New Conf instance

func (*Conf) Load

func (c *Conf) Load(file string, fileType FileType) error

Load configuration

func (*Conf) String

func (c *Conf) String() string

String config string

type DelayQueue

type DelayQueue struct {
	// listen address
	BindAddress string `yaml:"bind_address,omitempty" json:"bind_address,omitempty"`
	// bucket redis key name
	BucketName string `yaml:"bucket_name,omitempty" json:"bucket_name,omitempty"`
	// the number of delay queue bucket, increase number could get better concurrency.
	BucketSize uint64 `yaml:"bucket_size,omitempty" json:"bucket_size,omitempty"`
	// max fetch number of jobs in the bucket
	BucketMaxFetchNum uint64 `yaml:"bucket_max_fetch_num,omitempty" json:"bucket_max_fetch_num,omitempty"`
	// queue redis key name
	QueueName string `yaml:"queue_name,omitempty" json:"queue_name,omitempty"`
	// fetching job interval(ms), decrease interval may get better throughout.
	TimerFetchInterval int `yaml:"timer_fetch_interval,omitempty" json:"timer_fetch_interval,omitempty"`
	// fetch delay(ms), if there are still job in the bucket after the fetch
	// it will delay timer_fetch_delay ms for next fetch. Default is not wait.
	TimerFetchDelay int `yaml:"timer_fetch_delay,omitempty" json:"timer_fetch_delay,omitempty"`
}

DelayQueue delay queue configuration

type FileType

type FileType string

FileType configuration file type

const (
	// FileTypeYAML yaml type
	FileTypeYAML FileType = "yaml"
	// FileTypeJSON json type
	FileTypeJSON FileType = "json"
)

config file type enum

type Redis

type Redis struct {
	// Redis set up, "" for regular redis, "cluster" for redis cluster
	Mode RedisMode `yaml:"mode,omitempty" json:"mode,omitempty"`
	// The network type, either tcp or unix.
	// Default is tcp.
	Network string `yaml:"network,omitempty" json:"network,omitempty"`

	// host:port address.
	Address string `yaml:"address,omitempty" json:"address,omitempty"`

	// Use the specified username to authenticate the current connection
	// with one of the connections defined in the ACL list when connecting
	// to a Redis 6.0 instance, or greater, that is using the Redis ACL system.
	Username string `yaml:"username,omitempty" json:"username,omitempty"`

	// Optional password. Must match the password specified in the
	// require pass server configuration option (if connecting to a Redis 5.0 instance, or lower),
	// or the User password when connecting to a Redis 6.0 instance, or greater,
	// that is using the Redis ACL system.
	Password string `yaml:"password,omitempty" json:"password,omitempty"`

	// Database to be selected after connecting to the server.
	DB int `yaml:"db,omitempty" json:"db,omitempty"`

	// Dial timeout for establishing new connections.
	// Default is 5 seconds.
	DialTimeout int `yaml:"dial_timeout,omitempty" json:"dial_timeout,omitempty"`
	// Timeout for socket reads. If reached, commands will fail
	// with a timeout instead of blocking. Use value -1 for no timeout and 0 for default.
	// Default is 3 seconds.
	ReadTimeout int `yaml:"read_timeout,omitempty" json:"read_timeout,omitempty"`
	// Timeout for socket writes. If reached, commands will fail
	// with a timeout instead of blocking.
	// Default is ReadTimeout.
	WriteTimeout int `yaml:"write_timeout,omitempty" json:"write_timeout,omitempty"`

	// Maximum number of socket connections.
	// Default is 10 connections per every CPU as reported by runtime.NumCPU.
	PoolSize int `yaml:"pool_size,omitempty" json:"pool_size,omitempty"`
	// Minimum number of idle connections which is useful when establishing
	// new connection is slow.
	MinIdleConns int `yaml:"min_idle_conns,omitempty" json:"min_idle_conns,omitempty"`
}

Redis redis configuration

type RedisMode

type RedisMode string

RedisMode redis set up

const (
	// RedisModeNormal redis normal mode
	RedisModeNormal RedisMode = ""
	// RedisModeCluster redis cluster
	RedisModeCluster RedisMode = "cluster"
)

func (RedisMode) IsCluster

func (r RedisMode) IsCluster() bool

IsCluster return current redis mode is cluster