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

Implementation of WindowsMsgQueueEventBufferIfc. More...

#include <Imt.Base.Dff.ActiveParts.WinEC7/WindowsMsgQueueEventBuffer.h>

Inheritance diagram for imt::base::dff::activeparts::WindowsMsgQueueEventBuffer< BufferSize >:
imt::base::dff::activeparts::WindowsMsgQueueEventBufferIfc

Public Member Functions

 WindowsMsgQueueEventBuffer (void)
 Constructor. More...
 
virtual ~WindowsMsgQueueEventBuffer (void)
 Destructor. More...
 
void push (const uint16_t protocolIdentifier, const imt::base::core::serialization::SerializableIfc *const pEventData=NULL)
 Serialize data into the buffer (overwrite oldest if full). More...
 
virtual void pop (EventDataItem &item)
 
- Public Member Functions inherited from imt::base::dff::activeparts::WindowsMsgQueueEventBufferIfc
virtual ~WindowsMsgQueueEventBufferIfc (void)
 Destructor. More...
 

Detailed Description

template<uint16_t BufferSize>
class imt::base::dff::activeparts::WindowsMsgQueueEventBuffer< BufferSize >

Implementation of WindowsMsgQueueEventBufferIfc.

For each event which is received, an EventDataItem can be popped from the buffer. This allows us a fast thread safe access to the buffer, without the need of a locking mechanism.

Constructor & Destructor Documentation

◆ WindowsMsgQueueEventBuffer()

template<uint16_t BufferSize>
imt::base::dff::activeparts::WindowsMsgQueueEventBuffer< BufferSize >::WindowsMsgQueueEventBuffer ( void  )
inlineexplicit

Constructor.

◆ ~WindowsMsgQueueEventBuffer()

template<uint16_t BufferSize>
virtual imt::base::dff::activeparts::WindowsMsgQueueEventBuffer< BufferSize >::~WindowsMsgQueueEventBuffer ( void  )
inlinevirtual

Destructor.

Member Function Documentation

◆ pop()

template<uint16_t BufferSize>
virtual void imt::base::dff::activeparts::WindowsMsgQueueEventBuffer< BufferSize >::pop ( EventDataItem item)
inlinevirtual

◆ push()

template<uint16_t BufferSize>
void imt::base::dff::activeparts::WindowsMsgQueueEventBuffer< BufferSize >::push ( const uint16_t  protocolIdentifier,
const imt::base::core::serialization::SerializableIfc *const  pEventData = NULL 
)
inline

Serialize data into the buffer (overwrite oldest if full).

Parameters
protocolIdentifierIdentifier of the protocol.
pEventDataThe value to be added.

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