plugin

Documentation

Index

• Variables
• func RegisterConfigurator(name string, fn Configurator)
• func RegisterEngine(name string, fn EngineFactory)
• func RegisterServer(name string, fn ServerFactory)
• type Configurator
• type EngineFactory
• type ServerFactory

Variables

var Configurators map[string]Configurator

Configurators is a map of Configurator functions.

var EngineFactories map[string]EngineFactory

EngineFactories is a map where engine name matches EngineFactory.

var Metrics *metrics.Registry

Metrics is pointer to registry to keep Centrifugo metrics.

var ServerFactories map[string]ServerFactory

ServerFactories ia a map of ServerFactory functions.

Functions

func RegisterConfigurator

func RegisterConfigurator(name string, fn Configurator)

RegisterConfigurator allows to register custom configure function.

func RegisterEngine

func RegisterEngine(name string, fn EngineFactory)

RegisterEngine allows to register custom Engine implementation.

func RegisterServer

func RegisterServer(name string, fn ServerFactory)

RegisterServer allows to register custom Server implementation.

Types

type Configurator

type Configurator func(config.Setter) error

Configurator is a function that can set default option values, flags, ENV vars.

type EngineFactory

type EngineFactory func(*node.Node, config.Getter) (engine.Engine, error)

EngineFactory is a function that returns engine.Engine implementation.

type ServerFactory

type ServerFactory func(*node.Node, config.Getter) (server.Server, error)

ServerFactory is a function that returns server.Server implementation.