Dataflow Runtime API  4.0.1.0
Public Member Functions | List of all members
imt::base::dff::activeparts::ChannelIfc Class Referenceabstract

Interface of a channel to transmit data to a receiver. More...

#include <Imt.Base.Dff.ActiveParts/ChannelIfc.h>

Inheritance diagram for imt::base::dff::activeparts::ChannelIfc:
imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers > imt::base::dff::activeparts::ChannelOneToNull imt::base::dff::activeparts::ChannelOneToOne imt::base::dff::activeparts::test::ChannelMockIn imt::base::dff::activeparts::test::ChannelMockOut imt::base::dff::activeparts::ChannelInternalForwarder< NumberOfReceivers >

Public Member Functions

virtual ~ChannelIfc ()
 Destructor. More...
 
virtual void send (uint16_t const protocolIdentifier, ::imt::base::core::serialization::SerializableIfc const *const pEventData, size_t const eventDataSizeBytes)=0
 Send the given data to receiver through the scheduler. More...
 

Detailed Description

Interface of a channel to transmit data to a receiver.

ActiveParts are connected to each other via channels, which are for their part only connected to ports. Channels have the role of decoupling the sender from the receiver and handling the message transport.

Constructor & Destructor Documentation

◆ ~ChannelIfc()

virtual imt::base::dff::activeparts::ChannelIfc::~ChannelIfc ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ send()

virtual void imt::base::dff::activeparts::ChannelIfc::send ( uint16_t const  protocolIdentifier,
::imt::base::core::serialization::SerializableIfc const *const  pEventData,
size_t const  eventDataSizeBytes 
)
pure virtual

Send the given data to receiver through the scheduler.

Parameters
protocolIdentifieridentifier of protocol, is required for the receiver to decode pEventData.
pEventDatapointer to serializable event data, can also be nullptr.
eventDataSizeBytesMax number of bytes of serialized event data.

Implemented in imt::base::dff::activeparts::ChannelInternalForwarder< NumberOfReceivers >, imt::base::dff::activeparts::ChannelOneToOne, imt::base::dff::activeparts::ChannelOneToNull, imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers >, imt::base::dff::activeparts::test::ChannelMockOut, and imt::base::dff::activeparts::test::ChannelMockIn.


The documentation for this class was generated from the following file: