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

An event handler for capturing the interface removal event. More...

Inheritance diagram for InterfaceRemovalEventHandler:
IInterfaceRemovalEventHandler EventHandler

Public Member Functions

 InterfaceRemovalEventHandler ()
 Default Constructor. More...
 
virtual ~InterfaceRemovalEventHandler ()
 Virtual Destructor. More...
 
virtual void OnInterfaceRemoval (InterfacePtr pInterface)=0
 Interface removal event callback. More...
 
- Public Member Functions inherited from IInterfaceRemovalEventHandler
virtual ~IInterfaceRemovalEventHandler ()
 
- 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...
 

Protected Member Functions

InterfaceRemovalEventHandleroperator= (const InterfaceRemovalEventHandler &)
 Assignment operator. More...
 
- Protected Member Functions inherited from IInterfaceRemovalEventHandler
 IInterfaceRemovalEventHandler ()
 
 IInterfaceRemovalEventHandler (const IInterfaceRemovalEventHandler &)
 
IInterfaceRemovalEventHandleroperator= (const IInterfaceRemovalEventHandler &)
 
- Protected Member Functions inherited from EventHandler
 EventHandler ()
 
EventHandleroperator= (const EventHandler &)
 
void SetEventPayload (uint8_t *offset, size_t length)
 

Additional Inherited Members

- Protected Attributes inherited from EventHandler
EventData * m_pEventData
 

Detailed Description

An event handler for capturing the interface removal event.

Note that only GEV interface removals are currently handled.

Constructor & Destructor Documentation

Default Constructor.

virtual ~InterfaceRemovalEventHandler ( )
virtual

Virtual Destructor.

Member Function Documentation

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 IInterfaceRemovalEventHandler.

InterfaceRemovalEventHandler& operator= ( const InterfaceRemovalEventHandler )
protected

Assignment operator.


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