ManagedPort.hpp File Reference

Go to the source code of this file.

Data Structures
struct	dw::framework::ManagedPortInputBase::BoundProperties
struct	dw::framework::ManagedPortOutputBase::BoundProperties
struct	dw::framework::ManagedPortInputBase::ConstructProperties
struct	dw::framework::ManagedPortOutputBase::ConstructProperties
class	dw::framework::ManagedPortInput< T >::iterable::iterator< TT >
	Iterators. More...
class	dw::framework::ManagedPortBase
class	dw::framework::ManagedPortInput< T >
	Derived ManagedPortInput<T> provides type-specific interfaces for accessing buffers. More...
class	dw::framework::ManagedPortInputBase
	Base class encapsulates ownership of buffers and interactions with channel in type-agnostic way. More...
class	dw::framework::ManagedPortOutput< T >
	Derived ManagedPortOutput<T> provides type-specific interfaces for accessing buffers. More...
class	dw::framework::ManagedPortOutputBase
	Base class encapsulates ownership of buffers and interactions with channel in type-agnostic way. More...
struct	dw::framework::ManagedPortInputBase::Properties
struct	dw::framework::ManagedPortOutputBase::Properties

Namespaces
	dw
	dw::framework

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

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

---

Data Structure Documentation

dw::framework::ManagedPortInputBase::BoundProperties

struct dw::framework::ManagedPortInputBase::BoundProperties

Data Fields
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::BoundProperties

struct dw::framework::ManagedPortOutputBase::BoundProperties

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

dw::framework::ManagedPortInputBase::ConstructProperties

struct dw::framework::ManagedPortInputBase::ConstructProperties

Data Fields
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::ConstructProperties

struct dw::framework::ManagedPortOutputBase::ConstructProperties

dw::framework::ManagedPortInputBase::Properties

struct dw::framework::ManagedPortInputBase::Properties

Data Fields
BoundProperties	boundProperties	Properties deduced once port is bound to channel.
ConstructProperties	constructProperties	Properties deduced when port is constructed.

dw::framework::ManagedPortOutputBase::Properties

struct dw::framework::ManagedPortOutputBase::Properties

Data Fields
BoundProperties	boundProperties
ConstructProperties	constructProperties