The GBroadcasting Interface is capable of registering & deregistering GListener interfaces. More...

#include <GBroadcasting.h>

Inheritance diagram for GW::CORE::GBroadcasting:

Collaboration diagram for GW::CORE::GBroadcasting:

Public Member Functions
virtual GReturn	RegisterListener (GListener *_addListener, unsigned long long _eventMask)=0
	Any listener added to this class must receive all events unless otherwise specified by the _eventMask (optional). More...

virtual GReturn	DeregisterListener (GListener *_removeListener)=0
	A successfully deregistered listener will no longer receive events and have its reference count decremented by one. More...

Public Member Functions inherited from GW::CORE::GInterface
virtual GReturn	GetCount (unsigned int &_outCount)=0
	Return the total number of active references to this object. More...

virtual GReturn	IncrementCount ()=0
	Increase the total number of active references to this object. More...

virtual GReturn	DecrementCount ()=0
	Decrease the total number of active references to this object. More...

virtual GReturn	RequestInterface (const GUUIID &_interfaceID, void **_outputInterface)=0
	Requests an interface that may or may not be supported by this object. More...

Detailed Description

The GBroadcasting Interface is capable of registering & deregistering GListener interfaces.

The GBroadcaster will notify all registered listeners with the listeners OnEvent function. The events being registered for can be filtered with the _eventMask (optional). GBroadcasting Inherits directly from GMultiThreaded, therefore its implementation must be thread safe.

Member Function Documentation

◆ DeregisterListener()

virtual GReturn GW::CORE::GBroadcasting::DeregisterListener ( GListener * _removeListener )

pure virtual

A successfully deregistered listener will no longer receive events and have its reference count decremented by one.

Parameters

[in] _removeListener The listener to deregister from events.

Return values

SUCCESS The listener was successfully deregistered.

◆ RegisterListener()

virtual GReturn GW::CORE::GBroadcasting::RegisterListener	(	GListener *	_addListener,
		unsigned long long	_eventMask
	)

pure virtual

Any listener added to this class must receive all events unless otherwise specified by the _eventMask (optional).

Listeners registered to a broadcaster will have their reference counts increased by one until deregistered.