root/fi.utu.tech.powergoblin.api/ExternalAPI

ExternalAPI

interface ExternalAPI

Defines the hooks for defining external APIs such as HTTP, Telnet.

Inheritors

TelnetAPI

HTTPAPI1

HTTPAPI2

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.

busy

abstract fun busy(): List<String>

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

busyLogCount

abstract fun busyLogCount(): Int

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

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

abstract fun freePool(): MeterHandlerPool

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

getMqttMessages

abstract fun getMqttMessages(): List<MQTTMessageEntry>

Return a list of received MQTT messages.

globalConfiguration

abstract fun globalConfiguration(): GlobalConfiguration

Global configuration for this instance.

handleCommand

abstract fun handleCommand(cmd: Command): JsonResponse<*>

Handles commands. Commands are different from events in that they are not being logged. Session info is included if needed. The handling is synchronous, but long-running tasks might start asynchronous processes.

handleSessionEvent

abstract fun handleSessionEvent(event: SessionEvent, sessionId: Int? = null): JsonResponse<*>

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

handleSessionResourceEvents

abstract fun handleSessionResourceEvents(events: List<ResourceConsumptionEvent>, sessionId: Int? = null)

Handle multiple resource consumption events. If sessionId == null, it is the latest session.

handleTriggerEvent

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

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

instance

abstract fun instance(): String

Instance id.

instanceShortSummary

abstract fun instanceShortSummary(): InstanceShortSummary

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

instanceSummary

abstract fun instanceSummary(): InstanceSummary

Summary data structure for the whole app setup.

logEntries

abstract fun logEntries(): List<SessionLogEntry>

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

logFileCount

abstract 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

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

Data for displaying the images of the nodes

nodes

abstract 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

abstract fun pool(): MeterHandlerPool

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

qrImage

abstract fun qrImage(resource: String): ByteArray?

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

sendMqttMessage

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

Send a MQTT message with the given topic and content.

session

abstract fun session(id: Int? = null): Session

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

sessions

abstract fun sessions(): Collection<Session>

A snapshot of currently active & inactive sessions.

unsupportedCommand

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