api/rt.h ¶

Namespaces ¶

Name
cvedia
cvedia::rt API for controlling the server and lifecycle management of runtime instances.
cvedia::rt::api

Functions ¶

	Name
void	reloadConfig()
void	setPluginPath(std::string const & path)
std::vector< std::string >	getLoadedPlugins()
NODISCARD expected< void >	initialize(std::vector< std::string > const & pluginWhiteList ={}) Discover and register all plugins.
expected< void >	shutdown() Shutdown CVEDIA-RT engine.
expected< void >	stopAllInstances()
expected< void >	unloadAllInstances()
NODISCARD std::string	getVersion()
void	stop() Signal to stop the CVEDIA-RT engine.
bool	isDevMode()
void	setDevMode(bool devMode)
bool	isRunning() Returns the state of the server.
std::string	getRtVersion()
void	startWebserver()
void	stopWebserver()
void	startAutoDiscovery()
void	stopAutoDiscovery()

Functions Documentation ¶

function reloadConfig ¶

void reloadConfig()

function setPluginPath ¶

void setPluginPath(
    std::string const & path
)

function getLoadedPlugins ¶

std::vector< std::string > getLoadedPlugins()

function shutdown ¶

expected< void > shutdown()

Shutdown CVEDIA-RT engine.

Fully quiesce registered instance controllers and tear down the engine.

This is broader than stopAllInstances(): stopped-but-loaded registered controllers are unloaded before shared engine dependencies are destroyed. If controller quiescing or deletion fails, the engine remains initialized (but stopped) so the caller can inspect the error and retry shutdown(). SDK consumers must release registered controller references before shutdown, or release them before retrying a failed shutdown.

function stopAllInstances ¶

expected< void > stopAllInstances()

Stop visible, non-hidden registered controllers whose instances report that they are running.

Paused instances still report running and are stopped. A controller that is loaded but already stopped is intentionally left loaded. This operation is not an engine-shutdown barrier and does not cover controllers constructed directly through api::InstanceController.

function unloadAllInstances ¶

expected< void > unloadAllInstances()

Unload every loaded visible, non-hidden controller registered with the engine.

function getVersion ¶

NODISCARD std::string getVersion()

function stop ¶

void stop()

Signal to stop the CVEDIA-RT engine.

Publish the engine stop signal and close admission of new registered controllers. This does not release engine resources; call shutdown() and handle its result to complete orderly teardown.

function isDevMode ¶

bool isDevMode()

function setDevMode ¶

void setDevMode(
    bool devMode
)

function isRunning ¶

bool isRunning()

Returns the state of the server.

Return: Returns true if the server is running

function getRtVersion ¶

std::string getRtVersion()

function startWebserver ¶

void startWebserver()

function stopWebserver ¶

void stopWebserver()

function startAutoDiscovery ¶

void startAutoDiscovery()

function stopAutoDiscovery ¶

void stopAutoDiscovery()