modules

Documentation

Index

• type Module
• type Report

Types

type Module

type Module interface {
	Name() string
	Version() string
	Author() string
	DependsOn() events.EventType
	Run(communication.Input, chan communication.Result) (communication.Done, error)
	ParseConfig() error
	WriteDb(result communication.Result, db models.Database, projectName string) error
}

Module is the minimal interface needed for one module The Run function is the "main" function of each module ParseConfig will be run in the init system The WriteDb is called each time a new result is sent in the "communication.Result chan" DependsOn defines which "events" the module want to subscribe. It might be a new IP, domains, port...

type Report

type Report interface {
	Name() string
	Generate(name string) error
}

Report is the minimal interface for one reporting module The Generate function is the "main" function of the report module