Krill SDK/krill.zone.shared.krillapp.server/ServerMetaData

ServerMetaData

@Serializable

data class ServerMetaData(val name: String = "", val port: Int = 0, val model: String = "", val version: String = "", val os: String = "", val platform: Platform? = null, val isLocal: Boolean = false, val loggingEnabled: Boolean = false, val nodes: List<String> = emptyList(), val serialDevices: List<String> = emptyList(), val cameraAvailable: Boolean = false, val error: String = "", val sources: List<NodeIdentity> = emptyList(), val snapshot: Snapshot = Snapshot(), val invocationTriggers: List<InvocationTrigger> = emptyList(), val nodeAction: NodeAction = NodeAction.EXECUTE, val inputs: List<NodeIdentity> = emptyList()) : SourceMetaData(source)

Payload for a Server (or Server.Peer) node.

Constructors

ServerMetaData

constructor(name: String = "", port: Int = 0, model: String = "", version: String = "", os: String = "", platform: Platform? = null, isLocal: Boolean = false, loggingEnabled: Boolean = false, nodes: List<String> = emptyList(), serialDevices: List<String> = emptyList(), cameraAvailable: Boolean = false, error: String = "", sources: List<NodeIdentity> = emptyList(), snapshot: Snapshot = Snapshot(), invocationTriggers: List<InvocationTrigger> = emptyList(), nodeAction: NodeAction = NodeAction.EXECUTE, inputs: List<NodeIdentity> = emptyList())

Properties

cameraAvailable

val cameraAvailable: Boolean

true if the server has a camera attached and exposes the /camera/ routes.

error

open override val error: String

Last known error message for this node, or empty string when healthy.

inputs

open override val inputs: List<NodeIdentity>

sets the nodes this node reads from to complete its work when invoked

invocationTriggers

open override val invocationTriggers: List<InvocationTrigger>

The set of InvocationTriggers configured to wake this node. The node processor checks the incoming event against this list before doing any work. An empty list means "never auto-fire" — only manual execution.

isLocal

val isLocal: Boolean

true if the server was discovered via LAN multicast beacon. Used to decide whether to append .local to name when constructing reachable URLs (see resolvedHost).

loggingEnabled

val loggingEnabled: Boolean

true while verbose logging has been enabled on the server side.

model

val model: String

Hardware model description (e.g. "Raspberry Pi 5", "MacBook Pro").

name

val name: String

Display name — typically the host's network hostname.

nodeAction

open override val nodeAction: NodeAction

The action this node performs when it fires. Defaults to NodeAction.EXECUTE on every concrete implementation so that deserialising a payload that predates this field yields the original behaviour unchanged.

nodes

val nodes: List<String>

UUIDs of nodes hosted by this server — surfaced for fast counts in the UI.