COMLIB Namespace Reference

Real-time client/server communication primitives for talking to mne_rt_server. More...

Classes
class	RtClient
	Threaded façade that owns a paired command/data connection to mne_rt_server and re-emits streamed buffers. More...
class	RtCmdClient
	QTcpSocket subclass driving the mne_rt_server control channel (default port 4217). More...
struct	MetaData
	Value-type aggregate of the FIFF metadata blocks mne_rt_server sends at the start of a measurement. More...
class	RtDataClient
	QTcpSocket subclass that talks the FIFF wire dialect of the mne_rt_server data port (default 4218). More...
class	Command
	Named, parameterised command exchanged with mne_rt_server; supports both JSON and CLI serialisation. More...
class	CommandManager
	Observer-side registry of Command schemas a subsystem accepts from the shared CommandParser. More...
class	CommandParser
	Observer-pattern subject that decodes JSON or CLI command strings into RawCommand and notifies attached managers. More...
class	RawCommand
	Tokenised but unresolved command: a keyword plus a list of raw string arguments awaiting type binding. More...

Functions
COMSHARED_EXPORT const char *	buildDateTime ()
	Compile-time date/time stamp baked into the COMLIB binary.
COMSHARED_EXPORT const char *	buildHash ()
	Abbreviated git commit hash (typically 7 hex chars) of the source tree this library was built from.
COMSHARED_EXPORT const char *	buildHashLong ()
	Full-length git commit hash (40 hex chars) of the source tree this library was built from.

Detailed Description

Real-time client/server communication primitives for talking to mne_rt_server.

Aggregates two cooperating subsystems. rt_client/ holds the QThread- and QTcpSocket-derived clients that own the actual socket connections and surface received data through Qt signals; they are designed to be moved to (or constructed in) a worker thread so the UI thread is never blocked by network I/O. rt_command/ holds the command vocabulary used on the wire: RawCommand carries the tokenised request before types are known, Command carries a named, typed, parameter-bearing message that round-trips through JSON, CommandParser dispatches incoming text to all interested managers, and CommandManager is a per-component registry of the commands that component understands.

Function Documentation

buildDateTime()

const char * COMLIB::buildDateTime

(

)

Compile-time date/time stamp baked into the COMLIB binary.

Resolved from the __DATE__ / __TIME__ macros at build time and surfaced through utils/buildinfo.h. Used by About dialogs and bug reports to disambiguate identically-versioned builds.

Definition at line 35 of file com_global.cpp.

buildHash()

const char * COMLIB::buildHash

(

)

Abbreviated git commit hash (typically 7 hex chars) of the source tree this library was built from.

Populated by the MNE_GIT_HASH_SHORT compile definition set by the top-level CMake project. Returns an empty string for tree-only builds.

Definition at line 39 of file com_global.cpp.

buildHashLong()

const char * COMLIB::buildHashLong

(

)

Full-length git commit hash (40 hex chars) of the source tree this library was built from.

Populated by the MNE_GIT_HASH_LONG compile definition; intended for scripted provenance checks where the abbreviated hash is ambiguous.

Definition at line 43 of file com_global.cpp.