lib

package

v2025.1.7 Latest Latest Go to latest Published: Feb 17, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/roadrunner-server/roadrunner

Links

Open Source Insights

Documentation ¶

Overview ¶

Package lib provides a public API for embedding RoadRunner as a library. It exposes the RR type for programmatic control of the server lifecycle including starting, stopping, and accessing registered plugins.

Index ¶

func DefaultPluginsList() []any
type RR
- func NewRR(cfgFile string, override []string, pluginList []any) (*RR, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultPluginsList ¶

func DefaultPluginsList() []any

DefaultPluginsList returns all the plugins that RR can run with and are included by default

Types ¶

type RR ¶

type RR struct {
	Version string
	// contains filtered or unexported fields
}

func NewRR ¶

func NewRR(cfgFile string, override []string, pluginList []any) (*RR, error)

NewRR creates a new RR instance that can then be started or stopped by the caller

func (*RR) Plugins ¶

func (rr *RR) Plugins() []string

func (*RR) Serve ¶

func (rr *RR) Serve() error

Serve starts RR and starts listening for requests. This is a blocking call that will return an error if / when one occurs in a plugin

func (*RR) Stop ¶

func (rr *RR) Stop()

Stop stops roadrunner

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL