worker

Documentation

Index

• type Allocator
• type Options
  • func WithLog(z *zap.Logger) Options
• type Process
  • func InitBaseWorker(cmd *exec.Cmd, options ...Options) (*Process, error)
  • func (w *Process) AttachRelay(rl relay.Relay)
  • func (w *Process) Created() time.Time
  • func (w *Process) Kill() error
  • func (w *Process) Pid() int64
  • func (w *Process) Relay() relay.Relay
  • func (w *Process) Start() error
  • func (w *Process) State() worker.FSM
  • func (w *Process) Stop() error
  • func (w *Process) String() string
  • func (w *Process) Wait() error
  • func (w *Process) Write(p []byte) (int, error)
• type Worker
  • func From(process worker.BaseProcess) *Worker
  • func (tw *Worker) AttachRelay(rl relay.Relay)
  • func (tw *Worker) Created() time.Time
  • func (tw *Worker) Exec(p *payload.Payload) (*payload.Payload, error)
  • func (tw *Worker) ExecWithTTL(ctx context.Context, p *payload.Payload) (*payload.Payload, error)
  • func (tw *Worker) Kill() error
  • func (tw *Worker) Pid() int64
  • func (tw *Worker) Relay() relay.Relay
  • func (tw *Worker) Start() error
  • func (tw *Worker) State() worker.FSM
  • func (tw *Worker) Stop() error
  • func (tw *Worker) String() string
  • func (tw *Worker) Wait() error

Types

type Allocator

type Allocator func() (worker.Worker, error)

Allocator is responsible for worker allocation in the pool

type Options

type Options func(p *Process)

func WithLog

func WithLog(z *zap.Logger) Options

type Process

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

Process - supervised process with api over goridge.Relay.

func InitBaseWorker

func InitBaseWorker(cmd *exec.Cmd, options ...Options) (*Process, error)

InitBaseWorker creates new Process over given exec.cmd.

func (*Process) AttachRelay

func (w *Process) AttachRelay(rl relay.Relay)

AttachRelay attaches relay to the worker

func (*Process) Created

func (w *Process) Created() time.Time

Created returns time, worker was created at.

func (*Process) Kill

func (w *Process) Kill() error

Kill kills underlying process, make sure to call Wait() func to gather error log from the stderr. Does not wait for process completion!

func (*Process) Pid

func (w *Process) Pid() int64

Pid returns worker pid.

func (*Process) Relay

func (w *Process) Relay() relay.Relay

Relay returns relay attached to the worker

func (*Process) Start

func (w *Process) Start() error

func (*Process) State

func (w *Process) State() worker.FSM

State return receive-only Process state object, state can be used to safely access Process status, time when status changed and number of Process executions.

func (*Process) Stop

func (w *Process) Stop() error

Stop sends soft termination command to the Process and waits for process completion.

func (*Process) String

func (w *Process) String() string

String returns Process description. fmt.Stringer interface

func (*Process) Wait

func (w *Process) Wait() error

Wait must be called once for each Process, call will be released once Process is complete and will return process error (if any), if stderr is presented it is value will be wrapped as WorkerError. Method will return error code if php process fails to find or Start the script.

func (*Process) Write

func (w *Process) Write(p []byte) (int, error)

Worker stderr

type Worker

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

func From

func From(process worker.BaseProcess) *Worker

From creates SyncWorker from BaseProcess

func (*Worker) AttachRelay

func (tw *Worker) AttachRelay(rl relay.Relay)

func (*Worker) Created

func (tw *Worker) Created() time.Time

func (*Worker) Exec

func (tw *Worker) Exec(p *payload.Payload) (*payload.Payload, error)

Exec payload without TTL timeout.

func (*Worker) ExecWithTTL

func (tw *Worker) ExecWithTTL(ctx context.Context, p *payload.Payload) (*payload.Payload, error)

ExecWithTTL executes payload without TTL timeout.

func (*Worker) Kill

func (tw *Worker) Kill() error

func (*Worker) Pid

func (tw *Worker) Pid() int64

func (*Worker) Relay

func (tw *Worker) Relay() relay.Relay

func (*Worker) Start

func (tw *Worker) Start() error

func (*Worker) State

func (tw *Worker) State() worker.FSM

func (*Worker) Stop

func (tw *Worker) Stop() error

func (*Worker) String

func (tw *Worker) String() string

func (*Worker) Wait

func (tw *Worker) Wait() error