timebee

Documentation

Overview

Package timebee is a Bee that can fire events at a specific time.

Index

• type TimeBee
  • func (mod *TimeBee) ReloadOptions(options bees.BeeOptions)
  • func (mod *TimeBee) Run(eventChan chan bees.Event)
• type TimeBeeFactory
  • func (factory *TimeBeeFactory) Description() string
  • func (factory *TimeBeeFactory) Events() []bees.EventDescriptor
  • func (factory *TimeBeeFactory) ID() string
  • func (factory *TimeBeeFactory) Image() string
  • func (factory *TimeBeeFactory) LogoColor() string
  • func (factory *TimeBeeFactory) Name() string
  • func (factory *TimeBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
  • func (factory *TimeBeeFactory) Options() []bees.BeeOptionDescriptor

Types

type TimeBee

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

TimeBee is a Bee that can fire events at a specific time.

func (*TimeBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*TimeBee) Run

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

Run executes the Bee's event loop.

type TimeBeeFactory

type TimeBeeFactory struct {
	bees.BeeFactory
}

TimeBeeFactory is a factory for TimeBees.

func (*TimeBeeFactory) Description

func (factory *TimeBeeFactory) Description() string

Description returns the description of this Bee.

func (*TimeBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*TimeBeeFactory) ID

func (factory *TimeBeeFactory) ID() string

ID returns the ID of this Bee.

func (*TimeBeeFactory) Image

func (factory *TimeBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*TimeBeeFactory) LogoColor

func (factory *TimeBeeFactory) LogoColor() string

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

func (*TimeBeeFactory) Name

func (factory *TimeBeeFactory) Name() string

Name returns the name of this Bee.

func (*TimeBeeFactory) New

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

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

func (*TimeBeeFactory) Options

func (factory *TimeBeeFactory) Options() []bees.BeeOptionDescriptor

Options returns the options available to configure this Bee.