plugins

Documentation

Index

• Constants
• type Plugin
  • func Get(id PluginID, bus event.Manager, acn connectivity.ACN, onion string) (Plugin, error)
  • func NewConnectionRetry(bus event.Manager, onion string) Plugin
  • func NewNetworkCheck(bus event.Manager, acn connectivity.ACN) Plugin
• type PluginID
• type TimeoutPolicy
  • func (tp *TimeoutPolicy) ExecuteAction(action func() error) error

Constants

const NetworkCheckError = "Error"

NetworkCheckError is a status for when the NetworkCheck Plugin has had an error making an out going connection indicating it may be offline

const NetworkCheckSuccess = "Success"

NetworkCheckSuccess is a status for when the NetworkCheck Plugin has had a successful message from a peer, indicating it is online right now

Types

type Plugin

type Plugin interface {
	Start()
	Shutdown()
}

Plugin is the interface for a plugin

func Get

func Get(id PluginID, bus event.Manager, acn connectivity.ACN, onion string) (Plugin, error)

Get is a plugin factory for the requested plugin

func NewConnectionRetry

func NewConnectionRetry(bus event.Manager, onion string) Plugin

NewConnectionRetry returns a Plugin that when started will retry connecting to contacts with a backoff timing

func NewNetworkCheck

func NewNetworkCheck(bus event.Manager, acn connectivity.ACN) Plugin

NewNetworkCheck returns a Plugin that when started will attempt various network tests

type PluginID

type PluginID int

PluginID is used as an ID for signaling plugin activities

const (
	CONNECTIONRETRY PluginID = iota
	NETWORKCHECK
)

These are the plugin IDs for the supplied plugins

type TimeoutPolicy

type TimeoutPolicy time.Duration

TimeoutPolicy is an interface for enforcing common timeout patterns

func (*TimeoutPolicy) ExecuteAction

func (tp *TimeoutPolicy) ExecuteAction(action func() error) error

ExecuteAction runs a function and returns an error if it hasn't returned by the time specified by TimeoutPolicy