root/fi.utu.tech.powergoblin.measurement/Instance

Instance

class Instance(configuration: GlobalConfiguration, meterSources: Collection<MeterSource> = listOf(), subsystems: Collection<Subsystem> = meterSources, simulated: SimulatedMeterSource? = null, launchTime: <Error class: unknown class> = LocalDateTime.now(), val nodeManager: NodeManager = NodeManager()) : HTTPAPI, TelnetAPI, SessionContext

Handler for the application instance. Coordinates much of the application's functionality. Significant functionality is also delegated to meters' handlers, session handlers, and the server objects.

Constructors

Instance

constructor(configuration: GlobalConfiguration, meterSources: Collection<MeterSource> = listOf(), subsystems: Collection<Subsystem> = meterSources, simulated: SimulatedMeterSource? = null, launchTime: <Error class: unknown class> = LocalDateTime.now(), nodeManager: NodeManager = NodeManager())

Properties

executor

open override val executor: TaskExecutor

logManager

open override val logManager: LogManager

nodeManager

open override val nodeManager: NodeManager

staticContentPath

open override val staticContentPath: <Error class: unknown class>

webServer

open override val webServer: Webserver

Functions

activeMeasurement

open fun activeMeasurement(session: Int? = null): ActiveMeasurement?

Returns the active measurement in the session. If session == null, it is the latest session.

activeRun

open fun activeRun(session: Int? = null): ActiveRun?

Returns the active run id in the session. If session == null, it is the latest session.

apiCallsV2

open fun apiCallsV2(): <Error class: unknown class>

busy

open override fun busy(): <Error class: unknown class>

Does this instance still have active asynchronous tasks or active sessions planning to write on disk?

busyLogCount

open override fun busyLogCount(): Int

Tells how many sessions are still writing / planning to serialize their state on disk.

open fun close()

Only used when closing the whole application.

debug

fun debug(msg: String)

finishedMeasurements

open fun finishedMeasurements(session: Int? = null, measurement: Int? = null): List<MeasurementSummary>

Return a summary of a past measurement.

finishedRuns

open fun finishedRuns(session: Int? = null, run: Int? = null): List<RunSummary>

Returns a past run id in the session. If session == null, it is the latest session.

freePool

open override fun freePool(): MeterHandlerPool

The pool of all the free meters associated with the instance.

getMqttMessages

open override fun getMqttMessages(): <Error class: unknown class>

Return a list of received MQTT messages.

globalConfiguration

open override fun globalConfiguration(): GlobalConfiguration

Global configuration for this instance.

handleCommand

open override fun handleCommand(cmd: Command): JsonResponse<*>

Supports the following SystemAppCommands:

handleGetApiV1

open fun handleGetApiV1(uri: String, parts: List<String>): <Error class: unknown class>?

handleGetApiV2

open fun handleGetApiV2(uri: String, parts: List<String>): <Error class: unknown class>?

handleGetRequest

open fun handleGetRequest(uri: String): <Error class: unknown class>?

Handler for HTTP GET requests.

handlePostApiV1

open fun handlePostApiV1(uri: String, parts: List<String>, inputStream: <Error class: unknown class>): <Error class: unknown class>?

handlePostApiV2

open fun handlePostApiV2(uri: String, parts: List<String>, inputStream: <Error class: unknown class>): <Error class: unknown class>?

handlePostRequest

open fun handlePostRequest(uri: String, inputStream: <Error class: unknown class>): <Error class: unknown class>?

Handler for HTTP POST requests.

handleSessionEvent

open override fun handleSessionEvent(event: SessionEvent, sessionId: Int?): JsonResponse<*>

Handle an event. If sessionId == null, it is the latest session.

handleSessionResourceEvents

open override fun handleSessionResourceEvents(events: List<ResourceConsumptionEvent>, sessionId: Int?)

A faster routine for aggregate events (collectd stream)

handleTelnet

open fun handleTelnet(msg: String): String?

Handler for Telnet commands. The API is documented at https://tech.utugit.fi/soft/tools/power/doc/manual/usage/api/#telnet

handleTriggerEvent

open fun handleTriggerEvent(triggerType: TriggerType, sessionId: Int? = null): JsonResponse<*>

Handle a trigger event. If session == null, it is the latest session.

instance

open override fun instance(): String

Instance id.

instanceShortSummary

open override fun instanceShortSummary(): InstanceShortSummary

Shorter summary of the instance status. Faster to compute, for the web UI.

instanceSummary

open override fun instanceSummary(): InstanceSummary

Summary data structure for the whole app setup.

logEntries

open override fun logEntries(): List<SessionLogEntry>

Up-to-date snapshot of the log entries of the past sessions.

logFileCount

open override fun logFileCount(): Long

Tells how many ordinary files in located in the log directory. This can be an estimate and only needs to grow when a log has been serialized on disk.

nodeImage

open override fun nodeImage(resource: String): <Error class: unknown class><String, ByteArray>?

Data for displaying the images of the nodes

nodes

open override fun nodes(): List<NodeSummary>

Summary of external nodes associated with this instance.

open fun <T> ok(result: T?): JsonResponse<T>

Return a result packages in JsonResponse

pool

open override fun pool(): MeterHandlerPool

The pool of all meters associated with the instance. Does not include dummy copies of the meters.

qrImage

open override fun qrImage(resource: String): ByteArray?

Data for displaying the QR codes of the server's addresses.

restoreSession

fun restoreSession(sessionDirectory: String): Session

run

fun run()

Run the main functionality. In interactive mode, block until the user enters a new line (enter), otherwise sleep. We can't return because that will close the application.

sendMqttMessage

open fun sendMqttMessage(topic: String, content: String): JsonResponse<*>

Send a MQTT message with the given topic and content.

session

open override fun session(id: Int?): Session

Returns the session with the given id OR latest session OR throws an exception

sessions

open override fun sessions(): Collection<Session>

A snapshot of currently active & inactive sessions.

shutdownHook

fun shutdownHook(timeOut: Long): <Error class: unknown class>

staticPage

open fun staticPage(uri: String): <Error class: unknown class>?

unsupportedCommand

open fun unsupportedCommand(name: String?, type: String, uri: String? = null): JsonResponse<*>