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

Interface for any receiver. More...

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

Inheritance diagram for imt::base::dff::activeparts::ReceiverIfc:
imt::base::dff::activeparts::PortInput imt::base::dff::activeparts::PortInputSplit< NumberOfPortsToSplit >

Public Member Functions

virtual ~ReceiverIfc (void)
 Destructor. More...
 
virtual void receive (const uint16_t protocolIdentifier, const imt::base::core::serialization::SerializableIfc *const pEventData, const size_t eventDataSizeBytes) const =0
 Method called whenever a message shall be received. More...
 
virtual imt::base::dff::runtime::RuntimeCore::CoreHandle getReceiveHandle (void) const =0
 Get the handle of this input. More...
 
virtual imt::base::dff::runtime::RuntimePriority::Id getReceivePriority (void) const =0
 Get the priority of this input. More...
 

Detailed Description

Interface for any receiver.

Constructor & Destructor Documentation

◆ ~ReceiverIfc()

virtual imt::base::dff::activeparts::ReceiverIfc::~ReceiverIfc ( void  )
inlinevirtual

Destructor.

Member Function Documentation

◆ getReceiveHandle()

virtual imt::base::dff::runtime::RuntimeCore::CoreHandle imt::base::dff::activeparts::ReceiverIfc::getReceiveHandle ( void  ) const
pure virtual

Get the handle of this input.

Returns
Core handle.

Implemented in imt::base::dff::activeparts::PortInputSplit< NumberOfPortsToSplit >, and imt::base::dff::activeparts::PortInput.

◆ getReceivePriority()

virtual imt::base::dff::runtime::RuntimePriority::Id imt::base::dff::activeparts::ReceiverIfc::getReceivePriority ( void  ) const
pure virtual

Get the priority of this input.

Returns
Priority.

Implemented in imt::base::dff::activeparts::PortInputSplit< NumberOfPortsToSplit >, and imt::base::dff::activeparts::PortInput.

◆ receive()

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

Method called whenever a message shall be received.

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

Implemented in imt::base::dff::activeparts::PortInputSplit< NumberOfPortsToSplit >, and imt::base::dff::activeparts::PortInput.


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