Class XLinkIn

Inheritance Relationships

Base Type

Class Documentation

class XLinkIn : public dai::DeviceNodeCRTP<DeviceNode, XLinkIn, XLinkInProperties>

XLinkIn node. Receives messages over XLink.

Public Functions

virtual ~XLinkIn()
void setStreamName(const std::string &name)

Specifies XLink stream name to use.

The name should not start with double underscores ‘__’, as those are reserved for internal use.

Parameters:

name – Stream name

void setMaxDataSize(std::uint32_t maxDataSize)

Set maximum message size it can receive

Parameters:

maxDataSize – Maximum size in bytes

void setNumFrames(std::uint32_t numFrames)

Set number of frames in pool for sending messages forward

Parameters:

numFrames – Maximum number of frames in pool

std::string getStreamName() const

Get stream name.

std::uint32_t getMaxDataSize() const

Get maximum messages size in bytes.

std::uint32_t getNumFrames() const

Get number of frames in pool.

inline DeviceNodeCRTP()
inline DeviceNodeCRTP(const std::shared_ptr<Device> &device)
inline DeviceNodeCRTP(std::unique_ptr<Properties> props)
inline DeviceNodeCRTP(std::unique_ptr<Properties> props, bool confMode)
inline DeviceNodeCRTP(const std::shared_ptr<Device> &device, std::unique_ptr<Properties> props, bool confMode)

Public Members

Output out = {*this, {"out", DEFAULT_GROUP, {{{DatatypeEnum::Buffer, true}}}}}

Outputs message of same type as send from host.

Public Static Attributes

static constexpr const char *NAME = "XLinkIn"