Dataflow Runtime API  3.1.1.0
Classes | Public Member Functions | List of all members
imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers > Class Template Reference

Send the message on a One-to-Any channel (multiple receivers). More...

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

Inheritance diagram for imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers >:
imt::base::dff::activeparts::ChannelIfc imt::base::dff::activeparts::ChannelInternalForwarder< NumberOfReceivers >

Public Member Functions

 ChannelOneToAny (void)
 Constructor. More...
 
virtual ~ChannelOneToAny (void)
 Destructor. More...
 
virtual void send (const uint16_t protocolIdentifier, const imt::base::core::serialization::SerializableIfc *const pEventData, const size_t eventDataSizeBytes)
 
void connectPorts (PortOutput &portOut, const ReceiverIfc &portIn)
 Connect output port with input port via this channel. More...
 
- Public Member Functions inherited from imt::base::dff::activeparts::ChannelIfc
virtual ~ChannelIfc (void)
 Destructor. More...
 

Detailed Description

template<uint32_t NumberOfReceivers>
class imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers >

Send the message on a One-to-Any channel (multiple receivers).

A One-to-Any channel ensures that all receivers consume any given message in the order of the receiver priority.

Constructor & Destructor Documentation

◆ ChannelOneToAny()

template<uint32_t NumberOfReceivers>
imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers >::ChannelOneToAny ( void  )
inlineexplicit

Constructor.

◆ ~ChannelOneToAny()

template<uint32_t NumberOfReceivers>
virtual imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers >::~ChannelOneToAny ( void  )
inlinevirtual

Destructor.

Member Function Documentation

◆ connectPorts()

template<uint32_t NumberOfReceivers>
void imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers >::connectPorts ( PortOutput portOut,
const ReceiverIfc portIn 
)
inline

Connect output port with input port via this channel.

Remarks: call connectPorts for each receiver. If the number of registered receivers exceed NumberOfReceivers, the function returns without any side effect.

Parameters
portOutOutput port to connect.
portInInput port to connect.

◆ send()

template<uint32_t NumberOfReceivers>
virtual void imt::base::dff::activeparts::ChannelOneToAny< NumberOfReceivers >::send ( const uint16_t  protocolIdentifier,
const imt::base::core::serialization::SerializableIfc *const  pEventData,
const size_t  eventDataSizeBytes 
)
inlinevirtual

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