node

Documentation

Index

• Constants
• Variables
• func GetPluginIdentifier(name string) string
• func Shutdown()
• type Callback
• type Node
  • func New(plugins ...*Plugin) *Node
  • func Run(plugins ...*Plugin) *Node
  • func Start(plugins ...*Plugin) *Node
  • func (node *Node) Run()
  • func (node *Node) Start()
• type Plugin
  • func NewPlugin(name string, status int, callback Callback, callbacks ...Callback) *Plugin

Constants

const (
	LOG_LEVEL_FAILURE = 0
	LOG_LEVEL_WARNING = 1
	LOG_LEVEL_SUCCESS = 2
	LOG_LEVEL_INFO    = 3
	LOG_LEVEL_DEBUG   = 4
)

const (
	Disabled = iota
	Enabled
)

Variables

var DisabledPlugins = make(map[string]bool)

var EnabledPlugins = make(map[string]bool)

Functions

func GetPluginIdentifier

func GetPluginIdentifier(name string) string

func Shutdown

func Shutdown()

Types

type Callback

type Callback = func(plugin *Plugin)

type Node

type Node struct {
	Logger *logger.Logger
	// contains filtered or unexported fields
}

func New

func New(plugins ...*Plugin) *Node

func Run

func Run(plugins ...*Plugin) *Node

func Start

func Start(plugins ...*Plugin) *Node

func (*Node) Run

func (node *Node) Run()

func (*Node) Start

func (node *Node) Start()

type Plugin

type Plugin struct {
	Node   *Node
	Name   string
	Status int
	Events pluginEvents
	// contains filtered or unexported fields
}

func NewPlugin

func NewPlugin(name string, status int, callback Callback, callbacks ...Callback) *Plugin

Creates a new plugin with the given name, default status and callbacks. The last specified callback is the mandatory run callback, while all other callbacks are configure callbacks.