api/events.h ¶

Namespaces ¶

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

Functions ¶

	Name
expected< iface::EventBindId_t >	bindEvent(iface::EventCallback_t eventCallback, std::optional< iface::EventType_t > const & eventType ={}, std::optional< iface::InstanceId_t > const & instanceId ={}, std::optional< iface::DomainType_t > const & domain ={})
expected< void >	unbindEvent(iface::EventBindId_t bindId)
expected< void >	unbindEvents(std::optional< iface::EventType_t > const & eventType ={}, std::optional< iface::InstanceId_t > const & instanceId ={}, std::optional< iface::DomainType_t > const & domain ={})
expected< void >	postEvent(iface::EventData_t eventValues, std::optional< iface::EventType_t > const & eventType ={}, std::optional< iface::InstanceId_t > const & instanceId ={}, std::optional< iface::DomainType_t > const & domain ={})
std::set< iface::EventType_t >	getBoundEventTypes(std::optional< iface::InstanceId_t > const & instanceId ={}, std::optional< iface::DomainType_t > const & domain ={})
std::size_t	getBindCount(std::optional< iface::EventType_t > const & eventType ={}, std::optional< iface::InstanceId_t > const & instanceId ={}, std::optional< iface::DomainType_t > const & domain ={})
expected< void >	reset()

Functions Documentation ¶

function bindEvent ¶

expected< iface::EventBindId_t > bindEvent(
    iface::EventCallback_t eventCallback,
    std::optional< iface::EventType_t > const & eventType ={},
    std::optional< iface::InstanceId_t > const & instanceId ={},
    std::optional< iface::DomainType_t > const & domain ={}
)

function unbindEvent ¶

expected< void > unbindEvent(
    iface::EventBindId_t bindId
)

function unbindEvents ¶

expected< void > unbindEvents(
    std::optional< iface::EventType_t > const & eventType ={},
    std::optional< iface::InstanceId_t > const & instanceId ={},
    std::optional< iface::DomainType_t > const & domain ={}
)

function postEvent ¶

expected< void > postEvent(
    iface::EventData_t eventValues,
    std::optional< iface::EventType_t > const & eventType ={},
    std::optional< iface::InstanceId_t > const & instanceId ={},
    std::optional< iface::DomainType_t > const & domain ={}
)

function getBoundEventTypes ¶

std::set< iface::EventType_t > getBoundEventTypes(
    std::optional< iface::InstanceId_t > const & instanceId ={},
    std::optional< iface::DomainType_t > const & domain ={}
)

function getBindCount ¶

std::size_t getBindCount(
    std::optional< iface::EventType_t > const & eventType ={},
    std::optional< iface::InstanceId_t > const & instanceId ={},
    std::optional< iface::DomainType_t > const & domain ={}
)

function reset ¶

expected< void > reset()