plugins

Documentation

Index

• Constants
• type Plugin
  • func Get(id PluginID, bus event.Manager, acn connectivity.ACN, onion string) (Plugin, error)
  • func NewAntiSpam(bus event.Manager) Plugin
  • func NewConnectionRetry(bus event.Manager, onion string) Plugin
  • func NewHeartbeat(bus event.Manager) Plugin
  • func NewNetworkCheck(onion string, bus event.Manager, acn connectivity.ACN) Plugin
• type PluginID

Constants

const MaxBaseTimeoutSec = 5 * 60 // a max base time out of 5 min

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 NetworkCheckPeriod = time.Minute

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

const PriorityQueueTimeSinceQualifierHours float64 = 168

Types

type Plugin

type Plugin interface {
	Start()
	Shutdown()
	Id() PluginID
}

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 NewAntiSpam

func NewAntiSpam(bus event.Manager) Plugin

NewAntiSpam returns a Plugin that when started will trigger antispam payments on a regular interval

func NewConnectionRetry

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

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

func NewHeartbeat

func NewHeartbeat(bus event.Manager) Plugin

NewHeartbeat returns a Plugin that when started will trigger heartbeat checks on a regular interval

func NewNetworkCheck

func NewNetworkCheck(onion string, 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
	ANTISPAM
	HEARTBEAT
)

These are the plugin IDs for the supplied plugins