Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
us::ServiceListenerHook Struct Referenceabstract

Service Listener Hook Service. More...

#include <usServiceListenerHook.h>

Classes

struct  ListenerInfo
 Information about a Service Listener. This class describes the module which added the Service Listener and the filter with which it was added. More...
 

Public Member Functions

virtual ~ServiceListenerHook ()
 Destructor. More...
 
virtual void Added (const std::vector< ListenerInfo > &listeners)=0
 Added listeners hook method. This method is called to provide the hook implementation with information on newly added service listeners. This method will be called as service listeners are added while this hook is registered. Also, immediately after registration of this hook, this method will be called to provide the current collection of service listeners which had been added prior to the hook being registered. More...
 
virtual void Removed (const std::vector< ListenerInfo > &listeners)=0
 Removed listeners hook method. This method is called to provide the hook implementation with information on newly removed service listeners. This method will be called as service listeners are removed while this hook is registered. More...
 

Detailed Description

Service Listener Hook Service.

Modules registering this service will be called during service listener addition and removal.

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

Definition at line 38 of file usServiceListenerHook.h.

Constructor & Destructor Documentation

◆ ~ServiceListenerHook()

virtual us::ServiceListenerHook::~ServiceListenerHook ( )
virtual

Destructor.

Member Function Documentation

◆ Added()

virtual void us::ServiceListenerHook::Added ( const std::vector< ListenerInfo > &  listeners)
pure virtual

Added listeners hook method. This method is called to provide the hook implementation with information on newly added service listeners. This method will be called as service listeners are added while this hook is registered. Also, immediately after registration of this hook, this method will be called to provide the current collection of service listeners which had been added prior to the hook being registered.

Parameters
[in]listenersA collection of ListenerInfo objects for newly added service listeners which are now listening to service events.

◆ Removed()

virtual void us::ServiceListenerHook::Removed ( const std::vector< ListenerInfo > &  listeners)
pure virtual

Removed listeners hook method. This method is called to provide the hook implementation with information on newly removed service listeners. This method will be called as service listeners are removed while this hook is registered.

Parameters
[in]listenersA collection of ListenerInfo objects for newly removed service listeners which are no longer listening to service events.

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