plugin_template

package module
v0.0.0-...-7811374 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 21, 2025 License: MIT Imports: 3 Imported by: 0

README

plugin_template

RR plugin template.

This plugin template work's with v1 https://github.com/roadrunner-server/endure version and can be connected with v3 plugins.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

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

your configuration is here

func (*Config) InitDefaults

func (c *Config) InitDefaults()

InitDefaults used to initialize default configuration values

type Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshals it into a Struct.
	//
	// func (h *HttpService) Init(cp config.Configurer) error {
	//     h.config := &HttpConfig{}
	//     if err := configProvider.UnmarshalKey("http", h.config); err != nil {
	//         return err
	//     }
	// }
	UnmarshalKey(name string, out interface{}) error

	// Unmarshal unmarshal the config into a Struct. Make sure that the tags
	// on the fields of the structure are properly set.
	Unmarshal(out interface{}) error

	// Get used to get config section
	Get(name string) interface{}

	// Overwrite used to overwrite particular values in the unmarshalled config
	Overwrite(values map[string]interface{}) error

	// Has checks if config section exists.
	Has(name string) bool

	// GracefulTimeout represents timeout for all servers registered in the endure
	GracefulTimeout() time.Duration

	// RRVersion returns running RR version
	RRVersion() string
}

type Plugin

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

Plugin structure should have exactly the `Plugin` name to be found by RR

func (*Plugin) Init

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

Init will be called only once

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

Serve called after all Init functions will be resolved (for all plugins)

func (*Plugin) Stop

func (p *Plugin) Stop() error

Stop will be called after Serve always. It might be called when you stopping RR or if there is an error returned in Serve

Jump to

Keyboard shortcuts

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