module

type Config struct {
	Address string         `json:"address"`
	Config  *config.Config `json:"config,omitempty"`
}

type Init func(id int32, config *Config) (Module, error)

type Instance struct {
	ID          int32   `json:"id"`
	Type        *Type   `json:"-"`
	TypeID      int32   `json:"typeId"`
	Inst        Module  `json:"-"`
	Name        string  `json:"name"`
	Config      *Config `json:"config,omitempty"`
	Description string  `json:"description"`
	IsStarted   bool    `json:"started"`
}

type Module interface {

	// Id gets the module's unique identifier.
	ID() int32

	// Start starts the module.
	Start() error

	// Stop signals the module to stop.
	Stop() error

	// Name is the name of the module.
	Name() string

	// Address is the network address at which the module is available.
	Address() string

	// Description is a free-form field ot add descriptive information about
	// the module instance.
	Description() string
}

type Type struct {
	ID               int32     `json:"id"`
	Name             string    `json:"name"`
	IgnoreFailOnInit bool      `json:"-"`
	InitFunc         Init      `json:"-"`
	DefaultConfigs   []*Config `json:"defaultConfigs"`
}