Gateware Libraries  6.3.A
Beta Build
GW::CORE::GListener Class Referenceabstract

A GListener Interface may be registered with a GBroadcaster interface to receive event notifications. More...

#include <GListener.h>

Inheritance diagram for GW::CORE::GListener:
GW::CORE::GMultiThreaded GW::CORE::GInterface GW::GRAPHICS::GDirectX11Surface GW::GRAPHICS::GOpenGLSurface

Public Member Functions

virtual GReturn OnEvent (const GUUIID &_senderInterface, unsigned int _eventID, void *_eventData, unsigned int _dataSize)=0
 This operation is called whenever a GBroadcaster a listener is registered to generates an event. 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

A GListener Interface may be registered with a GBroadcaster interface to receive event notifications.

GListener is directly inherited from GMultiThreaded, therefore its implementation must be thread safe.

Member Function Documentation

◆ OnEvent()

virtual GReturn GW::CORE::GListener::OnEvent ( const GUUIID _senderInterface,
unsigned int  _eventID,
void *  _eventData,
unsigned int  _dataSize 
)
pure virtual

This operation is called whenever a GBroadcaster a listener is registered to generates an event.

Parameters
[in]_senderInterfaceThe interface of the sender object.
[in]_eventIDThe ID of the event sent.
[in]_eventDataThe data of the event.
[in]_dataSizeThe size of _eventData in bytes.

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