httpbee

Documentation

Overview

Package httpbee is a Bee that lets you trigger HTTP requests.

Index

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

Types

type HTTPBee

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

HTTPBee is a Bee that lets you trigger HTTP requests.

func (*HTTPBee) Action

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

Action triggers the action passed to it.

func (*HTTPBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*HTTPBee) Run

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

Run executes the Bee's event loop.

type HTTPBeeFactory

type HTTPBeeFactory struct {
	bees.BeeFactory
}

HTTPBeeFactory is a factory for HTTPBees.

func (*HTTPBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*HTTPBeeFactory) Description

func (factory *HTTPBeeFactory) Description() string

Description returns the description of this Bee.

func (*HTTPBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*HTTPBeeFactory) ID

func (factory *HTTPBeeFactory) ID() string

ID returns the ID of this Bee.

func (*HTTPBeeFactory) Image

func (factory *HTTPBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*HTTPBeeFactory) LogoColor

func (factory *HTTPBeeFactory) LogoColor() string

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

func (*HTTPBeeFactory) Name

func (factory *HTTPBeeFactory) Name() string

Name returns the name of this Bee.

func (*HTTPBeeFactory) New

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

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