server

README

Docs: link

Documentation

Index

• Constants
• type Config
  • func (cfg *Config) InitDefaults() error
• type Configurer
• type InitConfig
• type NamedLogger
• type Plugin
  • func (p *Plugin) CmdFactory(env map[string]string) func() *exec.Cmd
  • func (p *Plugin) GID() int
  • func (p *Plugin) Init(cfg Configurer, log NamedLogger) error
  • func (p *Plugin) Name() string
  • func (p *Plugin) NewPool(ctx context.Context, cfg *pool.Config, env map[string]string, _ *zap.Logger) (*staticPool.Pool, error)
  • func (p *Plugin) NewWorker(ctx context.Context, env map[string]string) (*worker.Process, error)
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) Stop(ctx context.Context) error
  • func (p *Plugin) UID() int
• type Pool
• type RPCConfig

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"
	// RrVersion env variable
	RrVersion string = "RR_VERSION"
)

Types

type Config

type Config struct {
	// OnInit configuration
	OnInit *InitConfig `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 map[string]string `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"`
}

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 Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshal it into a Struct.
	UnmarshalKey(name string, out any) error
	// Has checks if a config section exists.
	Has(name string) bool
	// RRVersion is the roadrunner current version
	RRVersion() string
}

type InitConfig

type InitConfig 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 map[string]string `mapstructure:"env"`
	// Env represents UID
	User string `mapstructure:"user"`
}

type NamedLogger

type NamedLogger interface {
	NamedLogger(name string) *zap.Logger
}

type Plugin

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

Plugin manages worker

func (*Plugin) CmdFactory

func (p *Plugin) CmdFactory(env map[string]string) func() *exec.Cmd

CmdFactory provides worker command factory associated with given context

func (*Plugin) GID

func (p *Plugin) GID() int

GID returns a group id (if specified by user)

func (*Plugin) Init

func (p *Plugin) Init(cfg Configurer, log NamedLogger) error

Init application provider.

func (*Plugin) Name

func (p *Plugin) Name() string

Name contains service name.

func (*Plugin) NewPool

func (p *Plugin) NewPool(ctx context.Context, cfg *pool.Config, env map[string]string, _ *zap.Logger) (*staticPool.Pool, error)

NewPool issues new worker pool.

func (*Plugin) NewWorker

func (p *Plugin) NewWorker(ctx context.Context, env map[string]string) (*worker.Process, error)

NewWorker issues new standalone worker.

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(ctx context.Context) error

Stop used to stop all allocated pools

func (*Plugin) UID

func (p *Plugin) UID() int

UID returns a user id (if specified by user)

type Pool

type Pool interface {
	// GetConfig returns pool configuration.
	GetConfig() *pool.Config
	// Workers returns worker list associated with the pool.
	Workers() (workers []*worker.Process)
	// RemoveWorker removes worker from the pool.
	RemoveWorker(ctx context.Context) error
	// AddWorker adds worker to the pool.
	AddWorker() error
	// Exec payload
	Exec(ctx context.Context, p *payload.Payload, stopCh chan struct{}) (chan *staticPool.PExec, error)
	// Reset kill all workers inside the watcher and replaces with new
	Reset(ctx context.Context) error
	// Destroy all underlying stack (but let them complete the task).
	Destroy(ctx context.Context)
}

Pool managed set of inner worker processes.

type RPCConfig

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

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