webbee

Documentation

Overview

Package webbee is a Bee that starts an HTTP server and fires events for incoming requests.

Index

• type WebBee
  • func (mod *WebBee) ReloadOptions(options bees.BeeOptions)
  • func (mod *WebBee) Run(cin chan bees.Event)
  • func (mod *WebBee) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type WebBeeFactory
  • func (factory *WebBeeFactory) Description() string
  • func (factory *WebBeeFactory) Events() []bees.EventDescriptor
  • func (factory *WebBeeFactory) ID() string
  • func (factory *WebBeeFactory) Image() string
  • func (factory *WebBeeFactory) LogoColor() string
  • func (factory *WebBeeFactory) Name() string
  • func (factory *WebBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
  • func (factory *WebBeeFactory) Options() []bees.BeeOptionDescriptor

Types

type WebBee

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

WebBee is a Bee that starts an HTTP server and fires events for incoming requests.

func (*WebBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*WebBee) Run

func (mod *WebBee) Run(cin chan bees.Event)

Run executes the Bee's event loop.

func (*WebBee) ServeHTTP

func (mod *WebBee) ServeHTTP(w http.ResponseWriter, req *http.Request)

type WebBeeFactory

type WebBeeFactory struct {
	bees.BeeFactory
}

WebBeeFactory is a factory for WebBees.

func (*WebBeeFactory) Description

func (factory *WebBeeFactory) Description() string

Description returns the description of this Bee.

func (*WebBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*WebBeeFactory) ID

func (factory *WebBeeFactory) ID() string

ID returns the ID of this Bee.

func (*WebBeeFactory) Image

func (factory *WebBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*WebBeeFactory) LogoColor

func (factory *WebBeeFactory) LogoColor() string

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

func (*WebBeeFactory) Name

func (factory *WebBeeFactory) Name() string

Name returns the name of this Bee.

func (*WebBeeFactory) New

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

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

func (*WebBeeFactory) Options

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

Options returns the options available to configure this Bee.