modules

package

v0.0.0-...-891f3ce Latest Latest Go to latest Published: Jul 30, 2019 License: BSD-2-Clause Imports: 16 Imported by: 0

Details

Package modules defines commonly used modules for bgpmon. It also defines some example modules that developers could build off of.

This section is empty.

This section is empty.

This section is empty.

type BaseDaemon struct {
	*BaseTask
	// contains filtered or unexported fields
}

BaseDaemon is an example daemon module which can be usefully composed in other modules.

func NewBaseDaemon(server core.BgpmondServer, logger util.Logger, name string) *BaseDaemon

NewBaseDaemon creates a base daemon with the server, logger and name.

func (b *BaseDaemon) GetType() int

GetType satisfies the module interface.

func (b *BaseDaemon) Run(launchOpts map[string]string)

Run satisfies the module interface, and prints waits for the module to be closed.

func (b *BaseDaemon) Stop() error

Stop satisfies the module interface. For a daemon module, this means cancelling the context and waiting for the Run function to complete.

type BaseTask struct {
	core.Module
	// contains filtered or unexported fields
}

BaseTask is an example task module which can be usefully composed in other modules.

func NewBaseTask(server core.BgpmondServer, logger util.Logger, name string) *BaseTask

NewBaseTask creates a base task with the server, logger and name.

func (b *BaseTask) GetInfo() core.OpenModuleInfo

GetInfo satisfies the module interface.

func (b *BaseTask) GetName() string

GetName satisfies the module interface.

func (b *BaseTask) GetType() int

GetType satisfies the module interface.

func (b *BaseTask) Run(launchOpts map[string]string)

Run satisfies the module interface.

func (b *BaseTask) Stop() error

Stop satisfies the module interface. A task is not stoppable.