execbee

Documentation

Overview

Package execbee is a Bee that can launch external processes.

Index

• type ExecBee
  • func (mod *ExecBee) Action(action bees.Action) []bees.Placeholder
  • func (mod *ExecBee) ReloadOptions(options bees.BeeOptions)
  • func (mod *ExecBee) Run(eventChan chan bees.Event)
• type ExecBeeFactory
  • func (factory *ExecBeeFactory) Actions() []bees.ActionDescriptor
  • func (factory *ExecBeeFactory) Description() string
  • func (factory *ExecBeeFactory) Events() []bees.EventDescriptor
  • func (factory *ExecBeeFactory) ID() string
  • func (factory *ExecBeeFactory) Image() string
  • func (factory *ExecBeeFactory) LogoColor() string
  • func (factory *ExecBeeFactory) Name() string
  • func (factory *ExecBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

Types

type ExecBee

type ExecBee struct {
	bees.Bee
	// contains filtered or unexported fields
}

ExecBee is a Bee that can launch external processes.

func (*ExecBee) Action

func (mod *ExecBee) Action(action bees.Action) []bees.Placeholder

Action triggers the action passed to it.

func (*ExecBee) ReloadOptions

func (mod *ExecBee) ReloadOptions(options bees.BeeOptions)

ReloadOptions parses the config options and initializes the Bee.

func (*ExecBee) Run

func (mod *ExecBee) Run(eventChan chan bees.Event)

Run executes the Bee's event loop.

type ExecBeeFactory

type ExecBeeFactory struct {
	bees.BeeFactory
}

ExecBeeFactory is a factory for ExecBees.

func (*ExecBeeFactory) Actions

func (factory *ExecBeeFactory) Actions() []bees.ActionDescriptor

Actions describes the available actions provided by this Bee.

func (*ExecBeeFactory) Description

func (factory *ExecBeeFactory) Description() string

Description returns the description of this Bee.

func (*ExecBeeFactory) Events

func (factory *ExecBeeFactory) Events() []bees.EventDescriptor

Events describes the available events provided by this Bee.

func (*ExecBeeFactory) ID

func (factory *ExecBeeFactory) ID() string

ID returns the ID of this Bee.

func (*ExecBeeFactory) Image

func (factory *ExecBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*ExecBeeFactory) LogoColor

func (factory *ExecBeeFactory) LogoColor() string

LogoColor returns the preferred logo background color (used by the admin interface).

func (*ExecBeeFactory) Name

func (factory *ExecBeeFactory) Name() string

Name returns the name of this Bee.

func (*ExecBeeFactory) New

func (factory *ExecBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

New returns a new Bee instance configured with the supplied options.