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

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

Inheritance diagram for InterfaceArrivalEventHandler:
IInterfaceArrivalEventHandler EventHandler

Public Member Functions

 InterfaceArrivalEventHandler ()
 Default constructor. More...
 
virtual ~InterfaceArrivalEventHandler ()
 Virtual destructor. More...
 
virtual void OnInterfaceArrival (InterfacePtr pInterface)=0
 Interface arrival event callback. More...
 
- 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...
 

Protected Member Functions

InterfaceArrivalEventHandleroperator= (const InterfaceArrivalEventHandler &)
 Assignment operator. More...
 
- 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)
 

Additional Inherited Members

- Protected Attributes inherited from EventHandler
EventData * m_pEventData
 

Detailed Description

An event handler for capturing the interface arrival event.

Note that only GEV interface arrivals are currently handled.

Constructor & Destructor Documentation

Default constructor.

virtual ~InterfaceArrivalEventHandler ( )
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 IInterfaceArrivalEventHandler.

InterfaceArrivalEventHandler& operator= ( const InterfaceArrivalEventHandler )
protected

Assignment operator.


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