Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
openlcb::ProxyEventHandler Class Referenceabstract

A proxy event handler has a single helper function that gets every event handler call with an indication of which call it is. More...

#include <EventHandlerTemplates.hxx>

Inheritance diagram for openlcb::ProxyEventHandler:
openlcb::EventHandler

Public Member Functions

virtual void HandlerFn (EventHandlerFunction fn, const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)=0
 This function will be called for any other incoming event handler function.
 
 DEFPROXYFN (handle_event_report)
 
 DEFPROXYFN (handle_consumer_identified)
 
 DEFPROXYFN (handle_consumer_range_identified)
 
 DEFPROXYFN (handle_producer_identified)
 
 DEFPROXYFN (handle_producer_range_identified)
 
 DEFPROXYFN (handle_identify_global)
 
 DEFPROXYFN (handle_identify_consumer)
 
 DEFPROXYFN (handle_identify_producer)
 
- Public Member Functions inherited from openlcb::EventHandler
virtual void handle_event_report (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)=0
 Called on incoming EventReport messages.
 
virtual void handle_consumer_identified (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)
 Called on another node sending ConsumerIdentified for this event.
 
virtual void handle_consumer_range_identified (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)
 Called on another node sending ConsumerRangeIdentified.
 
virtual void handle_producer_identified (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)
 Called on another node sending ProducerIdentified for this event.
 
virtual void handle_producer_range_identified (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)
 Called on another node sending ProducerRangeIdentified for this event.
 
virtual void handle_identify_global (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)=0
 Called on the need of sending out identification messages.
 
virtual void handle_identify_consumer (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)=0
 Called on another node sending IdentifyConsumer.
 
virtual void handle_identify_producer (const EventRegistryEntry &registry_entry, EventReport *event, BarrierNotifiable *done)=0
 Called on another node sending IdentifyProducer.
 

Additional Inherited Members

- Public Types inherited from openlcb::EventHandler
using EventReport = openlcb::EventReport
 
using EventRegistryEntry = openlcb::EventRegistryEntry
 
using EventId = openlcb::EventId
 

Detailed Description

A proxy event handler has a single helper function that gets every event handler call with an indication of which call it is.

It is helpful to create event containers that proxy calls to many event handler instances.

Definition at line 55 of file EventHandlerTemplates.hxx.

Constructor & Destructor Documentation

◆ ~ProxyEventHandler()

virtual openlcb::ProxyEventHandler::~ProxyEventHandler ( )
inlinevirtual

Definition at line 58 of file EventHandlerTemplates.hxx.


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