server

Documentation

Index

• Constants
• type Config
  • func (cfg *Config) InitDefaults() error
• type Env
• type OnInitConfig
• type Plugin
  • func (p *Plugin) Available()
  • func (p *Plugin) CmdFactory(env Env) func() *exec.Cmd
  • func (p *Plugin) Init(cfg config.Configurer, log logger.Logger) error
  • func (p *Plugin) Name() string
  • func (p *Plugin) NewWorker(ctx context.Context, env Env) (*worker.Process, error)
  • func (p *Plugin) NewWorkerPool(ctx context.Context, opt *pool.Config, env Env) (pool.Pool, error)
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) Stop() error
  • func (p *Plugin) Write(data []byte) (int, error)
• type RPCConfig
• type Server

Constants

const (
	// PluginName for the server
	PluginName string = "server"

	// RPCPluginName is the name of the RPC plugin, should be in sync with rpc/config.go
	RPCPluginName string = "rpc"

	// RrRelay env variable key (internal)
	RrRelay string = "RR_RELAY"

	// RrRPC env variable key (internal) if the RPC presents
	RrRPC string = "RR_RPC"

	PoolEvents    string = "pool.*"
	WorkerEvents  string = "worker.*"
	WatcherEvents string = "worker_watcher.*"
)

Types

type Config

type Config struct {
	// OnInit configuration
	OnInit *OnInitConfig `mapstructure:"on_init"`

	// Command to run as application.
	Command string `mapstructure:"command"`

	// User to run application under.
	User string `mapstructure:"user"`

	// Group to run application under.
	Group string `mapstructure:"group"`

	// Env represents application environment.
	Env Env `mapstructure:"env"`

	// Relay defines connection method and factory to be used to connect to workers:
	// "pipes", "tcp://:6001", "unix://rr.sock"
	// This config section must not change on re-configuration.
	Relay string `mapstructure:"relay"`

	// RelayTimeout defines for how long socket factory will be waiting for worker connection. This config section
	// must not change on re-configuration. Defaults to 60s.
	RelayTimeout time.Duration `mapstructure:"relay_timeout"`
}

Config All config (.rr.yaml) For other section use pointer to distinguish between `empty` and `not present`

func (*Config) InitDefaults

func (cfg *Config) InitDefaults() error

InitDefaults for the server config

type Env

type Env map[string]string

Env variables type alias

type OnInitConfig

type OnInitConfig struct {
	// Command which is started before worker starts
	Command string `mapstructure:"command"`

	// ExecTimeout is execute timeout for the command
	ExecTimeout time.Duration `mapstructure:"exec_timeout"`

	// Env represents application environment.
	Env Env `mapstructure:"env"`
}

type Plugin

type Plugin struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Plugin manages worker

func (*Plugin) Available

func (p *Plugin) Available()

Available interface implementation

func (*Plugin) CmdFactory

func (p *Plugin) CmdFactory(env Env) func() *exec.Cmd

CmdFactory provides worker command factory associated with given context.

func (*Plugin) Init

func (p *Plugin) Init(cfg config.Configurer, log logger.Logger) error

Init application provider.

func (*Plugin) Name

func (p *Plugin) Name() string

Name contains service name.

func (*Plugin) NewWorker

func (p *Plugin) NewWorker(ctx context.Context, env Env) (*worker.Process, error)

NewWorker issues new standalone worker.

func (*Plugin) NewWorkerPool

func (p *Plugin) NewWorkerPool(ctx context.Context, opt *pool.Config, env Env) (pool.Pool, error)

NewWorkerPool issues new worker pool.

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

Serve (Start) server plugin (just a mock here to satisfy interface)

func (*Plugin) Stop

func (p *Plugin) Stop() error

Stop used to close chosen in config factory

func (*Plugin) Write

func (p *Plugin) Write(data []byte) (int, error)

type RPCConfig

type RPCConfig struct {
	Listen string `mapstructure:"listen"`
}

RPCConfig should be in sync with rpc/config.go Used to set RPC address env

type Server

type Server interface {
	// CmdFactory return a new command based on the .rr.yaml server.command section
	CmdFactory(env Env) func() *exec.Cmd
	// NewWorker return a new worker with provided and attached by the user listeners and environment variables
	NewWorker(ctx context.Context, env Env) (*worker.Process, error)
	// NewWorkerPool return new pool of workers (PHP) with attached events listeners, env variables and based on the provided configuration
	NewWorkerPool(ctx context.Context, opt *pool.Config, env Env) (pool.Pool, error)
}

Server creates workers for the application.