Syntalos::InputPortInfo

Syntalos::InputPortInfo

Reference for an input port.

#include <syntaloslink.h>

Public Functions

Public Functions Documentation

function id

std::string id() const

function dataTypeId

int dataTypeId() const

function title

std::string title() const

function metadata

MetaStringMap metadata() const

function InputPortInfo

InputPortInfo(
    const InputPortInfo & 
) =delete

function operator=

InputPortInfo & operator=(
    const InputPortInfo & 
) =delete

function setNewDataRawCallback

void setNewDataRawCallback(
    NewDataRawFn callback
)

Sets a function to be called when new data arrives.

The data memory block passed to this function is only valid during the call.

function setThrottleItemsPerSec

void setThrottleItemsPerSec(
    uint itemsPerSec
)

function metadataValue

std::optional< MetaValue > metadataValue(
    const std::string & key
) const

Retrieves the metadata value associated with a given key.

Parameters:

• key The key to look up in the metadata.

Return: An optional MetaValue containing the value associated with the key, or std::nullopt if the key does not exist.

function metadataValueOr

MetaValue metadataValueOr(
    const std::string & key,
    const MetaValue & defaultVal
) const

function metadataValueOr

template <typename T >
inline T metadataValueOr(
    const std::string & key,
    T fallback
) const

Updated on 2026-04-24 at 23:36:58 +0000