famouso::mw::afp::AFPPublisherEventChannel< PEC, AFPFC, mtu, EventType > Class Template Reference
Publisher Event Channel with fragmentation support in the application layer. More...
#include <AFPPublisherEventChannel.h>
Public Member Functions | |
| AFPPublisherEventChannel (const Subject &s) | |
| Constructor. | |
| bool | publish (const EventType &e) |
| Publish an event. | |
Detailed Description
template<class PEC, class AFPFC, uint32_t mtu, class EventType = Event>
class famouso::mw::afp::AFPPublisherEventChannel< PEC, AFPFC, mtu, EventType >
Publisher Event Channel with fragmentation support in the application layer.
- Parameters:
-
PEC Publisher Event Channel AFPFC AFP fragmentation config mtu Maximum transmission unit (zero if not known at compile time) EventType Event type to support publishing for (needs data, length and subject member variables)
Constructor & Destructor Documentation
template<class PEC , class AFPFC , uint32_t mtu, class EventType = Event>
| famouso::mw::afp::AFPPublisherEventChannel< PEC, AFPFC, mtu, EventType >::AFPPublisherEventChannel | ( | const Subject & | s | ) | [inline] |
Constructor.
- Parameters:
-
s Subject of the channel
Member Function Documentation
template<class PEC , class AFPFC , uint32_t mtu, class EventType = Event>
| bool famouso::mw::afp::AFPPublisherEventChannel< PEC, AFPFC, mtu, EventType >::publish | ( | const EventType & | e | ) | [inline] |
Publish an event.
- Parameters:
-
e Event to publish
- Returns:
- True if fragmentation was successful.
References famouso::mw::Event::data, famouso::mw::afp::Fragmenter< AFPFC, mtu_compile_time >::error(), famouso::mw::afp::Fragmenter< AFPFC, mtu_compile_time >::get_fragment(), and famouso::mw::Event::length.
Referenced by famouso::mw::afp::AFPPublisherEventChannel< PEC, AFPFC, 0, EventType >::publish().
The documentation for this class was generated from the following file:
- include/mw/afp/AFPPublisherEventChannel.h