socketbee

Documentation

Overview

Package socketbee is a Bee that lets you transmit data via UDP sockets.

Index

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

Types

type SocketBee

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

SocketBee is a Bee that lets you transmit data via UDP sockets.

func (*SocketBee) Action

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

Action triggers the action passed to it.

func (*SocketBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*SocketBee) Run

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

Run executes the Bee's event loop.

type SocketBeeFactory

type SocketBeeFactory struct {
	bees.BeeFactory
}

SocketBeeFactory is a factory for SocketBees.

func (*SocketBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*SocketBeeFactory) Description

func (factory *SocketBeeFactory) Description() string

Description returns the description of this Bee.

func (*SocketBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*SocketBeeFactory) ID

func (factory *SocketBeeFactory) ID() string

ID returns the ID of this Bee.

func (*SocketBeeFactory) Image

func (factory *SocketBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*SocketBeeFactory) LogoColor

func (factory *SocketBeeFactory) LogoColor() string

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

func (*SocketBeeFactory) Name

func (factory *SocketBeeFactory) Name() string

Name returns the name of this Bee.

func (*SocketBeeFactory) New

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

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