Medical Imaging Interaction Toolkit  2023.04.99-980ed1b6
Medical Imaging Interaction Toolkit
ServiceEventListenerHook Struct Referenceabstract

#include <usServiceEventListenerHook.h>

Public Types

typedef ShrinkableMap< ModuleContext *, ShrinkableVector< ServiceListenerHook::ListenerInfo > > ShrinkableMapType

Public Member Functions

virtual ~ServiceEventListenerHook ()
virtual void Event (const ServiceEvent &event, ShrinkableMapType &listeners)=0

Detailed Description

Service Event Listener Hook Service.

Modules registering this service will be called during service (register, modify, and unregister service) operations.

Implementations of this interface are required to be thread-safe.

Definition at line 46 of file usServiceEventListenerHook.h.

Member Typedef Documentation

◆ ShrinkableMapType

typedef ShrinkableMap<ModuleContext*, ShrinkableVector<ServiceListenerHook::ListenerInfo> > ServiceEventListenerHook::ShrinkableMapType

Definition at line 48 of file usServiceEventListenerHook.h.

Constructor & Destructor Documentation

◆ ~ServiceEventListenerHook()

virtual ServiceEventListenerHook::~ServiceEventListenerHook ( )

Member Function Documentation

◆ Event()

virtual void ServiceEventListenerHook::Event ( const ServiceEvent &  event,
ShrinkableMapType listeners 
pure virtual

Event listener hook method. This method is called prior to service event delivery when a publishing module registers, modifies or unregisters a service. This method can filter the listeners which receive the event.

eventThe service event to be delivered.
listenersA map of Module Contexts to a list of Listener Infos for the module's listeners to which the specified event will be delivered. The implementation of this method may remove module contexts from the map and listener infos from the list values to prevent the event from being delivered to the associated listeners.

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