Compute Graph Framework SDK Reference  5.8
ManagedPort.hpp File Reference

Go to the source code of this file.

Classes

struct  dw::framework::ManagedPortOutputBase::BoundProperties
 
struct  dw::framework::ManagedPortInputBase::BoundProperties
 
struct  dw::framework::ManagedPortOutputBase::ConstructProperties
 
struct  dw::framework::ManagedPortInputBase::ConstructProperties
 
class  dw::framework::ManagedPortInput< T >::iterable::iterator< TT >
 Iterators. More...
 
class  dw::framework::ManagedPortBase
 
class  dw::framework::ManagedPortInput< T >
 
class  dw::framework::ManagedPortInputBase
 
class  dw::framework::ManagedPortOutput< T >
 
class  dw::framework::ManagedPortOutputBase
 
struct  dw::framework::ManagedPortOutputBase::Properties
 
struct  dw::framework::ManagedPortInputBase::Properties
 

Namespaces

namespace  dw
 
namespace  dw::framework
 

Typedefs

template<typename T >
using dw::framework::UniquePacketPtr = typename ManagedPortInput< T >::UniquePacketPtr
 

Functions

SyncedPacketPayload * dw::framework::extractSyncPacket (GenericData packet)
 

Class Documentation

◆ dw::framework::ManagedPortOutputBase::BoundProperties

struct dw::framework::ManagedPortOutputBase::BoundProperties
Class Members
bool syncEnabled

Whether this port is a sync port and will stamp the current cycle on all sync packets it produces.

◆ dw::framework::ManagedPortInputBase::BoundProperties

struct dw::framework::ManagedPortInputBase::BoundProperties
Class Members
uint32_t dataOffset

Offset from when an incoming packet was produced to the current cycle that must elapse before a packet can be releaesd to a consumer.

bool enableReuse

If all buffers have been released and there are no new buffers available on channel since recv() was last called, enableReuse will allow the last buffer acquired from the channel to be returned. Only 1 buffer will be re-usable in case multiple buffers were last acquired.

TODO(chale): move this to ConstructProperties once properties are passed by node instead of via channel.

bool syncEnabled

Whether this port is a sync port and will validate a packet's cycle counter.

◆ dw::framework::ManagedPortOutputBase::ConstructProperties

struct dw::framework::ManagedPortOutputBase::ConstructProperties

◆ dw::framework::ManagedPortInputBase::ConstructProperties

struct dw::framework::ManagedPortInputBase::ConstructProperties
Class Members
uint32_t maxBuffers

The maximum number of buffers this port can acquire at once.

dwTime_t waitTime

When recv() is called, calling thread will block at least waitTime number of us for a packet to arrive on the channel. TODO(chale): move to BoundProperties once it is supported.

◆ dw::framework::ManagedPortOutputBase::Properties

struct dw::framework::ManagedPortOutputBase::Properties
Collaboration diagram for dw::framework::ManagedPortOutputBase::Properties:
Class Members
BoundProperties boundProperties
ConstructProperties constructProperties

◆ dw::framework::ManagedPortInputBase::Properties

struct dw::framework::ManagedPortInputBase::Properties
Collaboration diagram for dw::framework::ManagedPortInputBase::Properties:
Class Members
BoundProperties boundProperties

Properties deduced once port is bound to channel.

ConstructProperties constructProperties

Properties deduced when port is constructed.