Service Event Listener Hook Service. More...

#include <usServiceEventListenerHook.h>

Public Types
typedef ShrinkableMap< ModuleContext *, ShrinkableVector< ServiceListenerHook::ListenerInfo > >	ShrinkableMapType
	Map type from ModuleContext pointers to shrinkable vectors of ListenerInfo. More...

Public Member Functions
virtual	~ServiceEventListenerHook ()
	Destructor. More...

virtual void	Event (const ServiceEvent &event, ShrinkableMapType &listeners)=0
	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. More...

Detailed Description

Service Event Listener Hook Service.

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

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

Definition at line 37 of file usServiceEventListenerHook.h.

Member Typedef Documentation

◆ ShrinkableMapType

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

Map type from ModuleContext pointers to shrinkable vectors of ListenerInfo.

Definition at line 40 of file usServiceEventListenerHook.h.

Constructor & Destructor Documentation

◆ ~ServiceEventListenerHook()

virtual us::ServiceEventListenerHook::~ServiceEventListenerHook ( )

virtual

Destructor.

Member Function Documentation

◆ Event()

virtual void us::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.

Parameters

[in]	event	The service event to be delivered.
[in]	listeners	A 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:

usServiceEventListenerHook.h

Public Types