pool

Documentation

Index

• Constants
• func NewStaticPool(ctx context.Context, cmd Command, factory ipc.Factory, conf any, ...) (pool.Pool, error)
• type Command
• type Config
  • func (cfg *Config) InitDefaults()
• type Options
  • func WithLogger(z *zap.Logger) Options
• type Pool
  • func (sp *Pool) Destroy(ctx context.Context)
  • func (sp *Pool) Exec(p *payload.Payload) (*payload.Payload, error)
  • func (sp *Pool) ExecStream(p *payload.Payload, resp chan *payload.Payload, _ chan struct{}) error
  • func (sp *Pool) ExecStreamWithTTL(ctx context.Context, p *payload.Payload, resp chan *payload.Payload, ...) error
  • func (sp *Pool) ExecWithTTL(ctx context.Context, p *payload.Payload) (*payload.Payload, error)
  • func (sp *Pool) GetConfig() any
  • func (sp *Pool) QueueSize() uint64
  • func (sp *Pool) RemoveWorker(wb worker.BaseProcess) error
  • func (sp *Pool) Reset(ctx context.Context) error
  • func (sp *Pool) Workers() (workers []worker.BaseProcess)
• type SupervisorConfig
  • func (cfg *SupervisorConfig) InitDefaults()

Constants

const (
	MB = 1024 * 1024
)

const NSEC_IN_SEC int64 = 1000000000 //nolint:stylecheck

NSEC_IN_SEC nanoseconds in second

const (
	// StopRequest can be sent by worker to indicate that restart is required.
	StopRequest = `{"stop":true}`
)

Functions

func NewStaticPool

func NewStaticPool(ctx context.Context, cmd Command, factory ipc.Factory, conf any, log *zap.Logger) (pool.Pool, error)

NewStaticPool creates new worker pool and task multiplexer. Pool will initiate with one worker.

Types

type Command

type Command func(cmd string) *exec.Cmd

type Config

type Config struct {
	// Debug flag creates new fresh worker before every request.
	Debug bool

	// Command used to override the server command with the custom one
	Command string `mapstructure:"command"`

	// NumWorkers defines how many sub-processes can be run at once. This value
	// might be doubled by Swapper while hot-swap. Defaults to number of CPU cores.
	NumWorkers uint64 `mapstructure:"num_workers"`

	// MaxJobs defines how many executions is allowed for the worker until
	// it's destruction. set 1 to create new process for each new task, 0 to let
	// worker handle as many tasks as it can.
	MaxJobs uint64 `mapstructure:"max_jobs"`

	// AllocateTimeout defines for how long pool will be waiting for a worker to
	// be freed to handle the task. Defaults to 60s.
	AllocateTimeout time.Duration `mapstructure:"allocate_timeout"`

	// DestroyTimeout defines for how long pool should be waiting for worker to
	// properly destroy, if timeout reached worker will be killed. Defaults to 60s.
	DestroyTimeout time.Duration `mapstructure:"destroy_timeout"`

	// Supervision config to limit worker and pool memory usage.
	Supervisor *SupervisorConfig `mapstructure:"supervisor"`
}

Config .. Pool config Configures the pool behavior.

func (*Config) InitDefaults

func (cfg *Config) InitDefaults()

InitDefaults enables default config values.

type Options

type Options func(p *Pool)

func WithLogger

func WithLogger(z *zap.Logger) Options

type Pool

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

Pool controls worker creation, destruction and task routing. Pool uses fixed amount of stack.

func (*Pool) Destroy

func (sp *Pool) Destroy(ctx context.Context)

Destroy all underlying stack (but let them complete the task).

func (*Pool) Exec

func (sp *Pool) Exec(p *payload.Payload) (*payload.Payload, error)

Exec executes provided payload on the worker

func (*Pool) ExecStream

func (sp *Pool) ExecStream(p *payload.Payload, resp chan *payload.Payload, _ chan struct{}) error

func (*Pool) ExecStreamWithTTL

func (sp *Pool) ExecStreamWithTTL(ctx context.Context, p *payload.Payload, resp chan *payload.Payload, _ chan struct{}) error

func (*Pool) ExecWithTTL

func (sp *Pool) ExecWithTTL(ctx context.Context, p *payload.Payload) (*payload.Payload, error)

ExecWithTTL sync with pool.Exec method

func (*Pool) GetConfig

func (sp *Pool) GetConfig() any

GetConfig returns associated pool configuration. Immutable.

func (*Pool) QueueSize

func (sp *Pool) QueueSize() uint64

func (*Pool) RemoveWorker

func (sp *Pool) RemoveWorker(wb worker.BaseProcess) error

func (*Pool) Reset

func (sp *Pool) Reset(ctx context.Context) error

func (*Pool) Workers

func (sp *Pool) Workers() (workers []worker.BaseProcess)

Workers returns worker list associated with the pool.

type SupervisorConfig

type SupervisorConfig struct {
	// WatchTick defines how often to check the state of worker.
	WatchTick time.Duration `mapstructure:"watch_tick"`

	// TTL defines maximum time worker is allowed to live.
	TTL time.Duration `mapstructure:"ttl"`

	// IdleTTL defines maximum duration worker can spend in idle mode. Disabled when 0.
	IdleTTL time.Duration `mapstructure:"idle_ttl"`

	// ExecTTL defines maximum lifetime per job.
	ExecTTL time.Duration `mapstructure:"exec_ttl"`

	// MaxWorkerMemory limits memory per worker.
	MaxWorkerMemory uint64 `mapstructure:"max_worker_memory"`
}

func (*SupervisorConfig) InitDefaults

func (cfg *SupervisorConfig) InitDefaults()

InitDefaults enables default config values.