backend.addon — Definition for module extension points

class backend.addon.AgentBase

Mixin class for anyone implementing Agent.

class backend.addon.Aggregator

Mixin class for anyone implementing Aggregator. Run on each control node. Potential hooks are:

process_REPORT_<type>(self, msg) process_GET_<type>(self, msg) process_PUT_<type>(self, msg) process_COMMAND(self, msg) doUpdates(self, now)

comm attribute will be set after creation, it will have the interface:

comm.sendToNode(msg, name) - experiment network comm.sendToExperiment(msg) - experiment network comm.sendToSinks(msg) - controller network comm.sendTo(msg) - controller network

doUpdates(now)

class backend.addon.Collector

Mixin class for anyone implementing Collector. Run on each experiment node.

connectStateChanged(isConnected)

Indicates that the control connection was made or lost

getReport(now)

Return None or a tuple of (type, data)

class backend.addon.Module

restoreData(default)

Utility for saving data

saveData(data)

Utility for saving data

class backend.addon.Service

Mixin class for anyone implementing Service.

class backend.addon.ServicesContainer

Add ability to refer to services as object attributes

start()

Instantiate any classes available now

backend.addon.loadModules(builtin=False, plugin=False)

Scan directories for py files and load them, picking out things we use