Syntalos::SyntalosLink

Connection to a Syntalos instance.

#include <syntaloslink.h>

Inherits from QObject

Public Functions

	Name
	~SyntalosLink() override
QString	instanceId() const
void	raiseError(const QString & message)
void	raiseError(const QString & title, const QString & message)
void	setLoadScriptCallback(LoadScriptFn callback)
void	setPrepareStartCallback(PrepareStartFn callback)
void	setStartCallback(StartFn callback)
void	setStopCallback(StopFn callback)
void	setShutdownCallback(ShutdownFn callback)
SyncTimer *	timer() const
void	awaitData(int timeoutUsec =-1, const std::function< void()> & eventFn =nullptr)
void	awaitDataForever(const std::function< void()> & eventFn =nullptr, int intervalUsec =125 *1000)
ModuleState	state() const
void	setState(ModuleState state)
void	setStatusMessage(const QString & message)
int	maxRealtimePriority() const
void	setSettingsData(const QByteArray & data)
void	setShowSettingsCallback(ShowSettingsFn callback)
void	setShowDisplayCallback(ShowDisplayFn callback)
std::vector< std::shared_ptr< InputPortInfo > >	inputPorts() const
std::vector< std::shared_ptr< OutputPortInfo > >	outputPorts() const
std::shared_ptr< InputPortInfo >	registerInputPort(const QString & id, const QString & title, const QString & dataTypeName)
std::shared_ptr< OutputPortInfo >	registerOutputPort(const QString & id, const QString & title, const QString & dataTypeName, const QVariantHash & metadata =QVariantHash())
void	updateOutputPort(const std::shared_ptr< OutputPortInfo > & oport)
void	updateInputPort(const std::shared_ptr< InputPortInfo > & iport)
bool	submitOutput(const std::shared_ptr< OutputPortInfo > & oport, const BaseDataType & data)

Friends

	Name
std::unique_ptr< SyntalosLink >	initSyntalosModuleLink()

Public Functions Documentation

function ~SyntalosLink

~SyntalosLink() override

function instanceId

QString instanceId() const

function raiseError

void raiseError(
    const QString & message
)

function raiseError

void raiseError(
    const QString & title,
    const QString & message
)

function setLoadScriptCallback

void setLoadScriptCallback(
    LoadScriptFn callback
)

function setPrepareStartCallback

void setPrepareStartCallback(
    PrepareStartFn callback
)

function setStartCallback

void setStartCallback(
    StartFn callback
)

function setStopCallback

void setStopCallback(
    StopFn callback
)

function setShutdownCallback

void setShutdownCallback(
    ShutdownFn callback
)

function timer

SyncTimer * timer() const

function awaitData

void awaitData(
    int timeoutUsec =-1,
    const std::function< void()> & eventFn =nullptr
)

Parameters:

timeoutUsec Timeout after which we return, or -1 to loop forever.
eventFn Callback to an external even processing function to be called occasionally.

Wait for incoming messages for the given amount of microseconds, then return.

When messages arrive, the respective callbacks are called.

function awaitDataForever

void awaitDataForever(
    const std::function< void()> & eventFn =nullptr,
    int intervalUsec =125 *1000
)

Parameters:

eventFn The event processing function to call.
intervalUsec The interval at which the function should be called.

Wait for incoming messages forever, calling callbacks in the current thread when they arrive.

If an event function is provided, it is called at the respective interval while we loop.

function state

ModuleState state() const

function setState

void setState(
    ModuleState state
)

function setStatusMessage

void setStatusMessage(
    const QString & message
)

function maxRealtimePriority

int maxRealtimePriority() const

function setSettingsData

void setSettingsData(
    const QByteArray & data
)

function setShowSettingsCallback

void setShowSettingsCallback(
    ShowSettingsFn callback
)

function setShowDisplayCallback

void setShowDisplayCallback(
    ShowDisplayFn callback
)

function inputPorts

std::vector< std::shared_ptr< InputPortInfo > > inputPorts() const

function outputPorts

std::vector< std::shared_ptr< OutputPortInfo > > outputPorts() const

function registerInputPort

std::shared_ptr< InputPortInfo > registerInputPort(
    const QString & id,
    const QString & title,
    const QString & dataTypeName
)

function registerOutputPort

std::shared_ptr< OutputPortInfo > registerOutputPort(
    const QString & id,
    const QString & title,
    const QString & dataTypeName,
    const QVariantHash & metadata =QVariantHash()
)

function updateOutputPort

void updateOutputPort(
    const std::shared_ptr< OutputPortInfo > & oport
)

function updateInputPort

void updateInputPort(
    const std::shared_ptr< InputPortInfo > & iport
)

function submitOutput

bool submitOutput(
    const std::shared_ptr< OutputPortInfo > & oport,
    const BaseDataType & data
)

Friends

friend initSyntalosModuleLink

friend std::unique_ptr< SyntalosLink > initSyntalosModuleLink();

Updated on 2026-03-16 at 19:16:01 +0000

Syntalos::SyncTimer Syntalos::SyntalosLinkModule