plugin

Documentation

Index

• type Core
  • func (c *Core) GetPlugin(name string) (MyrteaPlugin, bool)
  • func (c *Core) PluginExists(name string) (exists bool)
  • func (c *Core) RegisterPlugins()
  • func (c *Core) Start()
  • func (c *Core) Stop()
• type MyrteaPlugin
• type Plugin

Types

type Core

type Core struct {
	Plugins []Plugin
}

func (*Core) GetPlugin

func (c *Core) GetPlugin(name string) (MyrteaPlugin, bool)

GetPlugin returns a plugin by its name

func (*Core) PluginExists

func (c *Core) PluginExists(name string) (exists bool)

PluginExists checks if a plugin with the given name exists

func (*Core) RegisterPlugins

func (c *Core) RegisterPlugins()

RegisterPlugins Registers all plugins that were added into the TOML config file

func (*Core) Start

func (c *Core) Start()

Start starts all plugins

func (*Core) Stop

func (c *Core) Stop()

Stop stops all plugins registered in core

type MyrteaPlugin

type MyrteaPlugin interface {
	ServicePort() int
	HandlerPrefix() string
	Handler() http.Handler
	Start() error
	Stop() error
	Running() bool
}

MyrteaPlugin is a standard interface for any myrtea plugins

type Plugin

type Plugin struct {
	Config pluginutils.PluginConfig
	Plugin MyrteaPlugin
}