cronbee

Documentation

Overview

Package cronbee is a Bee that acts like a time-based job scheduler (cron).

Index

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

Types

type CronBee

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

CronBee is a Bee that acts like a time-based job scheduler (cron).

func (*CronBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*CronBee) Run

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

Run executes the Bee's event loop.

type CronBeeFactory

type CronBeeFactory struct {
	bees.BeeFactory
}

CronBeeFactory is a factory for CronBees.

func (*CronBeeFactory) Description

func (factory *CronBeeFactory) Description() string

Description returns the description of this Bee.

func (*CronBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*CronBeeFactory) ID

func (factory *CronBeeFactory) ID() string

ID returns the ID of this Bee.

func (*CronBeeFactory) Image

func (factory *CronBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*CronBeeFactory) LogoColor

func (factory *CronBeeFactory) LogoColor() string

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

func (*CronBeeFactory) Name

func (factory *CronBeeFactory) Name() string

Name returns the name of this Bee.

func (*CronBeeFactory) New

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

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

func (*CronBeeFactory) Options

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

Options returns the options available to configure this Bee.