mirror of
https://github.com/acaloiaro/neoq
synced 2026-07-21 10:12:18 +00:00
51 lines
2.3 KiB
Go
51 lines
2.3 KiB
Go
package config
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/acaloiaro/neoq/logging"
|
|
"github.com/acaloiaro/neoq/types"
|
|
)
|
|
|
|
const (
|
|
DefaultIdleTxTimeout = 30000
|
|
// the window of time between time.Now() and when a job's RunAfter comes due that neoq will schedule a goroutine to
|
|
// schdule the job for execution.
|
|
// E.g. right now is 16:00 and a job's RunAfter is 16:30 of the same date. This job will get a dedicated goroutine to
|
|
// wait until the job's RunAfter, scheduling the job to be run exactly at RunAfter
|
|
DefaultFutureJobWindow = 30 * time.Second
|
|
DefaultJobCheckInterval = 1 * time.Second
|
|
)
|
|
|
|
// Config configures neoq and its backends
|
|
//
|
|
// This configuration struct includes options for all backends. As such, some of its options are not implicable to all
|
|
// backends. [BackendConcurrency], for example, is only used by the redis backend. Other backends manage concurrency on a
|
|
// per-handler basis.
|
|
type Config struct {
|
|
BackendInitializer BackendInitializer
|
|
BackendAuthPassword string // password with which to authenticate to the backend's data provider
|
|
BackendConcurrency int // total number of backend processes available to process jobs
|
|
ConnectionString string // a string containing connection details for the backend
|
|
JobCheckInterval time.Duration // the interval of time between checking for new future/retry jobs
|
|
FutureJobWindow time.Duration // time duration between current time and job.RunAfter that goroutines schedule for future jobs
|
|
IdleTransactionTimeout int // the number of milliseconds PgBackend transaction may idle before the connection is killed
|
|
ShutdownTimeout time.Duration // duration to wait for jobs to finish during shutdown
|
|
LogLevel logging.LogLevel // the log level of the default logger
|
|
}
|
|
|
|
// Option is a function that sets optional backend configuration
|
|
type Option func(c *Config)
|
|
|
|
// New initiailizes a new Config with defaults
|
|
func New() *Config {
|
|
return &Config{
|
|
FutureJobWindow: DefaultFutureJobWindow,
|
|
JobCheckInterval: DefaultJobCheckInterval,
|
|
IdleTransactionTimeout: DefaultIdleTxTimeout,
|
|
}
|
|
}
|
|
|
|
// BackendInitializer is a function that initializes a backend
|
|
type BackendInitializer func(ctx context.Context, opts ...Option) (backend types.Backend, err error)
|