daemoncontroltypes.h File Reference

Typed daemon-control payloads used above the transport layer. More...

#include "config.h"
#include <QJsonObject>
#include <QString>

Go to the source code of this file.

Classes
struct	DaemonStatusSnapshot
	Daemon-owned runtime status snapshot for tray and CLI clients. More...
struct	DaemonConfigSnapshot
	Daemon-owned config snapshot for tray and CLI clients. More...

Functions
QJsonObject	daemonStatusSnapshotToJsonObject (const DaemonStatusSnapshot &snapshot)
	Converts a typed daemon status snapshot to its transport JSON shape.
QJsonObject	daemonConfigSnapshotToJsonObject (const DaemonConfigSnapshot &snapshot)
	Converts a typed daemon config snapshot to its transport JSON shape.
bool	parseDaemonStatusSnapshot (const QJsonObject &object, DaemonStatusSnapshot *snapshotOut, QString *errorMessage=nullptr)
	Parses a typed daemon status snapshot from a protocol payload object.
bool	parseDaemonConfigSnapshot (const QJsonObject &object, DaemonConfigSnapshot *snapshotOut, QString *errorMessage=nullptr)
	Parses a typed daemon config snapshot from a protocol payload object.

Detailed Description

Typed daemon-control payloads used above the transport layer.

Definition in file daemoncontroltypes.h.

Function Documentation

daemonConfigSnapshotToJsonObject()

QJsonObject daemonConfigSnapshotToJsonObject

(

const DaemonConfigSnapshot &

snapshot

)

Converts a typed daemon config snapshot to its transport JSON shape.

Parameters

snapshot

Snapshot to serialize.

Returns

JSON object suitable for the daemon control protocol payload.

daemonStatusSnapshotToJsonObject()

QJsonObject daemonStatusSnapshotToJsonObject

(

const DaemonStatusSnapshot &

snapshot

)

Converts a typed daemon status snapshot to its transport JSON shape.

Parameters

snapshot

Snapshot to serialize.

Returns

JSON object suitable for the daemon control protocol payload.

parseDaemonConfigSnapshot()

bool parseDaemonConfigSnapshot	(	const QJsonObject &	object,
		DaemonConfigSnapshot *	snapshotOut,
		QString *	errorMessage = nullptr
	)

Parses a typed daemon config snapshot from a protocol payload object.

Parameters

object	JSON object returned by the daemon control protocol.
snapshotOut	Output target for the parsed snapshot.
errorMessage	Optional output for parse failures.

Returns

true when the payload is valid.

parseDaemonStatusSnapshot()

bool parseDaemonStatusSnapshot	(	const QJsonObject &	object,
		DaemonStatusSnapshot *	snapshotOut,
		QString *	errorMessage = nullptr
	)

Parses a typed daemon status snapshot from a protocol payload object.

Parameters

object	JSON object returned by the daemon control protocol.
snapshotOut	Output target for the parsed snapshot.
errorMessage	Optional output for parse failures.

Returns

true when the payload is valid.