root/fi.utu.tech.powergoblin.agent/Agent

Agent

class Agent(configuration: AgentConfiguration, pool: <Error class: unknown class>)

The agent manages the node. It maintains a connection to the PowerGoblin service, it constantly polls for new commands and performs them sequentially.

Most commands block until they either fail or succeed. The collector command is started as a background process.

Constructors

Agent

constructor(configuration: AgentConfiguration, pool: <Error class: unknown class>)

Properties

startTime

val startTime: <Error class: unknown class>

Start time of the agent.

Functions

open fun close()

Close the client and shut down connections.

delete

fun delete(cmd: AgentDeleteMeasurementCommand): String

determineCapabilities

fun determineCapabilities(cmd: AgentDetermineCapabilitiesCommand)

Determines the collection capabilities of the agent. Processes the AgentDetermineCapabilitiesCommand.

download

fun download(cmd: AgentDownloadMeasurementCommand)

Fetch a measurement. Processes the AgentDownloadMeasurementCommand.

fun download(input: <Error class: unknown class>, targetCandidate: String): AgentDownloadTask

Download the measurement from the input stream. This is used by the local web API.

enumeratePlans

fun enumeratePlans(): List<PlanEntry>

execute

fun execute(cmd: AgentExecuteCommand): String

Execute and arbitrary command / script. Processes the AgentExecuteCommand.

generateStatus

fun generateStatus(): AgentStatus

getHandler

fun getHandler(exchange: WebServer.Exchange)

Handler for GET requests coming from the integrated web server.

isCollecting

fun isCollecting(): Boolean

launchCollectd

fun launchCollectd(cmd: AgentCollectCommand, filter: List<CollectorFlag> = capabilities)

Start the collector (collectd). Processes the AgentCollectCommand.

listen

fun listen()

Starts a loop where first a connection is established. Once we have a connection, new commands are queried periodically.

measure

fun measure(cmd: AgentMeasureCommand)

Starts a measurement. Processes the AgentMeasureCommand.

postHandler

fun postHandler(exchange: WebServer.Exchange)

Handler for POST requests coming from the integrated web server.

powerOff

fun powerOff()

Powers off the whole node, including the agent. Processes the AgentPowerOffCommand.

processDownload

fun processDownload(task: AgentDownloadTask, target: <Error class: unknown class>, input: ByteArray)

Fetch a measurement. Processes the AgentDownloadMeasurementCommand.

reboot

fun reboot()

Reboot the whole node, including the agent. Processes the AgentPowerOffCommand.

reconfigure

fun reconfigure(cmd: AgentReconfigureCommand)

Reconfigure the agent. Processes the AgentReconfigureCommand.

runCommand

fun runCommand(cmd: AgentCommand, log: Boolean = true): String?

Processes a polymorphic AgentCommand.

stopCollectd

fun stopCollectd()

Stops the collector (collectd). Processes the AgentCollectorStopCommand.

updateStatus

fun updateStatus(newTask: AgentTask? = null)