api/instances.h ¶

Namespaces ¶

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

Classes ¶

	Name
struct	cvedia::rt::api::instances::InstanceWriteModel

Functions ¶

	Name
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	createInstanceController(InstanceWriteModel const & model)
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	createInstanceController() Create a new Runtime Instance with automatic instancename generation.
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	createInstanceController(Uuid const & instanceId)
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	createInstanceControllerFromMemory(Uuid const & instanceId, std::string const & solutionId)
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	createInstanceControllerFromMemory(std::string const & solutionId)
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	createInstanceControllerFromFile(std::string const & configFile)
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	cloneInstanceController(std::shared_ptr< iface::InstanceController > ctrl)
NODISCARD expected< void >	updateInstanceController(std::shared_ptr< iface::InstanceController > ctrl, InstanceWriteModel const & model)
NODISCARD expected< std::shared_ptr< iface::Instance > >	createInstance(Uuid const & instanceId, std::string const & instanceName)
NODISCARD expected< std::shared_ptr< iface::Instance > >	createInstance(std::string const & instanceName)
NODISCARD expected< void >	deleteInstanceController(Uuid const & instanceId)
NODISCARD expected< void >	deleteAllInstanceControllers()
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	getInstanceController(Uuid const & uuid)
NODISCARD expected< std::shared_ptr< iface::InstanceController > >	getInstanceControllerWithTouch(Uuid const & uuid)
NODISCARD expected< std::weak_ptr< iface::Instance > >	getInstanceById(Uuid const & uuid)
NODISCARD bool	isLoaded(Uuid const & uuid)
NODISCARD bool	isRunning(Uuid const & uuid)
NODISCARD bool	isPaused(Uuid const & uuid)
NODISCARD expected< void >	unloadInstance(Uuid const & uuid)
NODISCARD expected< void >	startInstance(Uuid const & uuid)
NODISCARD expected< void >	stopInstance(Uuid const & uuid, bool allowRestart)
NODISCARD expected< void >	restartInstance(Uuid const & uuid)
NODISCARD std::unordered_set< std::shared_ptr< iface::InstanceController > >	getInstanceControllers()
NODISCARD expected< void >	discoverInstances()
NODISCARD expected< std::shared_ptr< iface::Module > >	getModuleByName(std::string const & moduleName)
NODISCARD std::shared_ptr< InstanceRegistry const >	getRunningInstancesRegistry()

Functions Documentation ¶

function createInstanceController ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > createInstanceController(
    InstanceWriteModel const & model
)

Preferred controller creation APIs for SDK consumers.

Controllers returned by these functions are registered with the engine and therefore participate in its creation-admission and shutdown-quiesce protocol. Prefer these overloads to direct construction through api::InstanceController.

function createInstanceController ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > createInstanceController()

Create a new Runtime Instance with automatic instancename generation.

function createInstanceController ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > createInstanceController(
    Uuid const & instanceId
)

function createInstanceControllerFromMemory ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > createInstanceControllerFromMemory(
    Uuid const & instanceId,
    std::string const & solutionId
)

function createInstanceControllerFromMemory ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > createInstanceControllerFromMemory(
    std::string const & solutionId
)

function createInstanceControllerFromFile ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > createInstanceControllerFromFile(
    std::string const & configFile
)

function cloneInstanceController ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > cloneInstanceController(
    std::shared_ptr< iface::InstanceController > ctrl
)

function updateInstanceController ¶

NODISCARD expected< void > updateInstanceController(
    std::shared_ptr< iface::InstanceController > ctrl,
    InstanceWriteModel const & model
)

function createInstance ¶

NODISCARD expected< std::shared_ptr< iface::Instance > > createInstance(
    Uuid const & instanceId,
    std::string const & instanceName
)

function createInstance ¶

NODISCARD expected< std::shared_ptr< iface::Instance > > createInstance(
    std::string const & instanceName
)

function deleteInstanceController ¶

NODISCARD expected< void > deleteInstanceController(
    Uuid const & instanceId
)

function deleteAllInstanceControllers ¶

NODISCARD expected< void > deleteAllInstanceControllers()

function getInstanceController ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > getInstanceController(
    Uuid const & uuid
)

function getInstanceControllerWithTouch ¶

NODISCARD expected< std::shared_ptr< iface::InstanceController > > getInstanceControllerWithTouch(
    Uuid const & uuid
)

function getInstanceById ¶

NODISCARD expected< std::weak_ptr< iface::Instance > > getInstanceById(
    Uuid const & uuid
)

function isLoaded ¶

NODISCARD bool isLoaded(
    Uuid const & uuid
)

function isRunning ¶

NODISCARD bool isRunning(
    Uuid const & uuid
)

function isPaused ¶

NODISCARD bool isPaused(
    Uuid const & uuid
)

function unloadInstance ¶

NODISCARD expected< void > unloadInstance(
    Uuid const & uuid
)

function startInstance ¶

NODISCARD expected< void > startInstance(
    Uuid const & uuid
)

function stopInstance ¶

NODISCARD expected< void > stopInstance(
    Uuid const & uuid,
    bool allowRestart
)

function restartInstance ¶

NODISCARD expected< void > restartInstance(
    Uuid const & uuid
)

function getInstanceControllers ¶

NODISCARD std::unordered_set< std::shared_ptr< iface::InstanceController > > getInstanceControllers()

function discoverInstances ¶

NODISCARD expected< void > discoverInstances()

function getModuleByName ¶

NODISCARD expected< std::shared_ptr< iface::Module > > getModuleByName(
    std::string const & moduleName
)

function getRunningInstancesRegistry ¶

NODISCARD std::shared_ptr< InstanceRegistry const > getRunningInstancesRegistry()