Documentation ¶
Index ¶
Constants ¶
View Source
const (
// DefaultResultsExpireIn is a default time used to expire task states and group metadata from the backend
DefaultResultsExpireIn = 3600
)
Variables ¶
This section is empty.
Functions ¶
func ReadFromFile ¶
ReadFromFile reads data from a file
Types ¶
type AMQPConfig ¶
type AMQPConfig struct { Exchange string `yaml:"exchange" envconfig:"AMQP_EXCHANGE"` ExchangeType string `yaml:"exchange_type" envconfig:"AMQP_EXCHANGE_TYPE"` QueueDeclareArgs QueueDeclareArgs `yaml:"queue_declare_args" envconfig:"AMQP_QUEUE_DECLARE_ARGS"` QueueBindingArgs QueueBindingArgs `yaml:"queue_binding_args" envconfig:"AMQP_QUEUE_BINDING_ARGS"` BindingKey string `yaml:"binding_key" envconfig:"AMQP_BINDING_KEY"` PrefetchCount int `yaml:"prefetch_count" envconfig:"AMQP_PREFETCH_COUNT"` AutoDelete bool `yaml:"auto_delete" envconfig:"AMQP_AUTO_DELETE"` }
AMQPConfig wraps RabbitMQ related configuration
type Config ¶
type Config struct { Broker string `yaml:"broker" envconfig:"BROKER"` MultipleBrokerSeparator string `yaml:"multiple_broker_separator" envconfig:"MULTIPLE_BROKEN_SEPARATOR"` DefaultQueue string `yaml:"default_queue" envconfig:"DEFAULT_QUEUE"` ResultBackend string `yaml:"result_backend" envconfig:"RESULT_BACKEND"` ResultsExpireIn int `yaml:"results_expire_in" envconfig:"RESULTS_EXPIRE_IN"` AMQP *AMQPConfig `yaml:"amqp"` SQS *SQSConfig `yaml:"sqs"` Redis *RedisConfig `yaml:"redis"` GCPPubSub *GCPPubSubConfig `yaml:"-" ignored:"true"` MongoDB *MongoDBConfig `yamk:"-" ignored:"true"` TLSConfig *tls.Config // NoUnixSignals - when set disables signal handling in machinery NoUnixSignals bool `yaml:"no_unix_signals" envconfig:"NO_UNIX_SIGNALS"` DynamoDB *DynamoDBConfig `yaml:"dynamodb"` }
Config holds all configuration for our program
func NewFromEnvironment ¶
NewFromEnvironment creates a config object from environment variables
type DynamoDBConfig ¶ added in v1.3.1
type DynamoDBConfig struct { Client *dynamodb.DynamoDB TaskStatesTable string `yaml:"task_states_table" envconfig:"TASK_STATES_TABLE"` GroupMetasTable string `yaml:"group_metas_table" envconfig:"GROUP_METAS_TABLE"` }
DynamoDBConfig wraps DynamoDB related configuration
type GCPPubSubConfig ¶
GCPPubSubConfig wraps GCP PubSub related configuration
type MongoDBConfig ¶
MongoDBConfig ...
type QueueBindingArgs ¶
type QueueBindingArgs map[string]interface{}
QueueBindingArgs arguments which are used when binding to the exchange
func (*QueueBindingArgs) Decode ¶
func (args *QueueBindingArgs) Decode(value string) error
Decode from yaml to map (any field whose type or pointer-to-type implements envconfig.Decoder can control its own deserialization)
type QueueDeclareArgs ¶
type QueueDeclareArgs map[string]interface{}
QueueDeclareArgs arguments which are used when declaring a queue
type RedisConfig ¶ added in v1.3.6
type RedisConfig struct { // Maximum number of idle connections in the pool. // Default: 10 MaxIdle int `yaml:"max_idle" envconfig:"REDIS_MAX_IDLE"` // Maximum number of connections allocated by the pool at a given time. // When zero, there is no limit on the number of connections in the pool. // Default: 100 MaxActive int `yaml:"max_active" envconfig:"REDIS_MAX_ACTIVE"` // Close connections after remaining idle for this duration in seconds. If the value // is zero, then idle connections are not closed. Applications should set // the timeout to a value less than the server's timeout. // Default: 300 IdleTimeout int `yaml:"max_idle_timeout" envconfig:"REDIS_IDLE_TIMEOUT"` // If Wait is true and the pool is at the MaxActive limit, then Get() waits // for a connection to be returned to the pool before returning. // Default: true Wait bool `yaml:"wait" envconfig:"REDIS_WAIT"` // ReadTimeout specifies the timeout in seconds for reading a single command reply. // Default: 15 ReadTimeout int `yaml:"read_timeout" envconfig:"REDIS_READ_TIMEOUT"` // WriteTimeout specifies the timeout in seconds for writing a single command. // Default: 15 WriteTimeout int `yaml:"write_timeout" envconfig:"REDIS_WRITE_TIMEOUT"` // ConnectTimeout specifies the timeout in seconds for connecting to the Redis server when // no DialNetDial option is specified. // Default: 15 ConnectTimeout int `yaml:"connect_timeout" envconfig:"REDIS_CONNECT_TIMEOUT"` // NormalTasksPollPeriod specifies the period in milliseconds when polling redis for normal tasks // Default: 1000 NormalTasksPollPeriod int `yaml:"normal_tasks_poll_period" envconfig:"REDIS_NORMAL_TASKS_POLL_PERIOD"` // DelayedTasksPollPeriod specifies the period in milliseconds when polling redis for delayed tasks // Default: 20 DelayedTasksPollPeriod int `yaml:"delayed_tasks_poll_period" envconfig:"REDIS_DELAYED_TASKS_POLL_PERIOD"` DelayedTasksKey string `yaml:"delayed_tasks_key" envconfig:"REDIS_DELAYED_TASKS_KEY"` // MasterName specifies a redis master name in order to configure a sentinel-backed redis FailoverClient MasterName string `yaml:"master_name" envconfig:"REDIS_MASTER_NAME"` // Dialer specifies custom dialer function to connect to redi�s, only redigo takes effect now Dialer func(string, string) (net.Conn, error) }
RedisConfig ...
type SQSConfig ¶ added in v1.2.1
type SQSConfig struct { Client *sqs.SQS WaitTimeSeconds int `yaml:"receive_wait_time_seconds" envconfig:"SQS_WAIT_TIME_SECONDS"` // https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html // visibility timeout should default to nil to use the overall visibility timeout for the queue VisibilityTimeout *int `yaml:"receive_visibility_timeout" envconfig:"SQS_VISIBILITY_TIMEOUT"` }
SQSConfig wraps SQS related configuration
Click to show internal directories.
Click to hide internal directories.