Spinnaker C++
4.0.0.116
Public Member Functions | Protected Member Functions | List of all members
SystemEventHandler Class Referenceabstract

A handler to interface arrival and removal events on the system. More...

Inheritance diagram for SystemEventHandler:
ISystemEventHandler IInterfaceArrivalEventHandler IInterfaceRemovalEventHandler EventHandler EventHandler SystemEventHandlerImpl

Public Member Functions

 SystemEventHandler ()
 Default constructor. More...
 
virtual ~SystemEventHandler ()
 Virtual destructor. More...
 
virtual void OnInterfaceArrival (InterfacePtr pInterface)=0
 Interface arrival event callback. More...
 
virtual void OnInterfaceRemoval (InterfacePtr pInterface)=0
 Interface removal event callback. More...
 
- Public Member Functions inherited from ISystemEventHandler
virtual ~ISystemEventHandler ()
 
- Public Member Functions inherited from IInterfaceArrivalEventHandler
virtual ~IInterfaceArrivalEventHandler ()
 
- Public Member Functions inherited from EventHandler
virtual ~EventHandler ()
 Virtual Destructor. More...
 
void SetEventType (EventType eventType)
 Sets the event type. More...
 
EventType GetEventType ()
 Gets the event type. More...
 
const uint8_t * GetEventPayloadData ()
 Gets the event payload data. More...
 
const size_t GetEventPayloadDataSize ()
 Gets the event payload data size. More...
 
- Public Member Functions inherited from IInterfaceRemovalEventHandler
virtual ~IInterfaceRemovalEventHandler ()
 

Protected Member Functions

SystemEventHandleroperator= (const SystemEventHandler &)
 Assignment operator. More...
 
- Protected Member Functions inherited from ISystemEventHandler
 ISystemEventHandler ()
 
 ISystemEventHandler (const ISystemEventHandler &)
 
ISystemEventHandleroperator= (const ISystemEventHandler &)
 
- Protected Member Functions inherited from IInterfaceArrivalEventHandler
 IInterfaceArrivalEventHandler ()
 
 IInterfaceArrivalEventHandler (const IInterfaceArrivalEventHandler &)
 
IInterfaceArrivalEventHandleroperator= (const IInterfaceArrivalEventHandler &)
 
- Protected Member Functions inherited from EventHandler
 EventHandler ()
 
EventHandleroperator= (const EventHandler &)
 
void SetEventPayload (uint8_t *offset, size_t length)
 
- Protected Member Functions inherited from IInterfaceRemovalEventHandler
 IInterfaceRemovalEventHandler ()
 
 IInterfaceRemovalEventHandler (const IInterfaceRemovalEventHandler &)
 
IInterfaceRemovalEventHandleroperator= (const IInterfaceRemovalEventHandler &)
 

Additional Inherited Members

- Protected Attributes inherited from EventHandler
EventData * m_pEventData
 

Detailed Description

A handler to interface arrival and removal events on the system.

Note that only GEV interface arrivals and removals are currently handled.

Examples:
EnumerationEvents.cpp.

Constructor & Destructor Documentation

Default constructor.

virtual ~SystemEventHandler ( )
virtual

Virtual destructor.

Member Function Documentation

virtual void OnInterfaceArrival ( InterfacePtr  pInterface)
pure virtual

Interface arrival event callback.

Note that only GEV interface arrivals are currently handled.

Parameters
pInterfaceReference tracked pointer to Interface object of the adapter attached to the system

Implements ISystemEventHandler.

Implemented in SystemEventHandlerImpl.

virtual void OnInterfaceRemoval ( InterfacePtr  pInterface)
pure virtual

Interface removal event callback.

Note that only GEV interface removals are currently handled.

Parameters
pInterfaceReference tracked pointer to Interface object of the adapter removed from the system

Implements ISystemEventHandler.

Implemented in SystemEventHandlerImpl.

SystemEventHandler& operator= ( const SystemEventHandler )
protected

Assignment operator.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference