modules

Documentation

Index

• type Manager
  • func NewManager() *Manager
  • func (m *Manager) AddDependency(name string, dependsOn ...string) error
  • func (m *Manager) InitModuleServices(target string) (map[string]services.Service, error)
  • func (m *Manager) RegisterModule(name string, initFn func() (services.Service, error))

Types

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager is a component that initialises modules of the application in the right order of dependencies.

func NewManager

func NewManager() *Manager

NewManager creates a new Manager

func (*Manager) AddDependency

func (m *Manager) AddDependency(name string, dependsOn ...string) error

AddDependency adds a dependency from name(source) to dependsOn(targets) An error is returned if the source module name is not found

func (*Manager) InitModuleServices

func (m *Manager) InitModuleServices(target string) (map[string]services.Service, error)

InitModuleServices initialises the target module by initialising all its dependencies in the right order. Modules are wrapped in such a way that they start after their dependencies have been started and stop before their dependencies are stopped.

func (*Manager) RegisterModule

func (m *Manager) RegisterModule(name string, initFn func() (services.Service, error))

RegisterModule registers a new module with name and init function name must be unique to avoid overwriting modules if initFn is nil, the module will not initialise