IVmShutdownEventObserver Interface Reference

Observer interface for receiving VM Shutdown events. More...

#include <MpiAPI.h>

Inheritance diagram for IVmShutdownEventObserver:

IEventObserver

List of all members.

Public Member Functions

virtual TEventType Type ()
 Returns the event type supported by the observer.
virtual BitSet EventDataTypes ()
 Returns the data items to provide with the event when it occurs.
virtual void HandleEvent ()=0
 Event Handler.


Detailed Description

The VM Shutdown event is sent when the VM is about to shut down. No events will be sent after this event.

The event will be sent only if the VM was successfully initialized. It will not be sent in case of a VM start-up failure.


Member Function Documentation

virtual TEventType Type (  )  [inline, virtual]

Returns the MPI event type requested by the observer. Implemented for each observer interface class. MPI clients that implement event-specific observer classes must not override this method.

Returns:
the MPI event type

Implements IEventObserver.

virtual BitSet EventDataTypes (  )  [inline, virtual]

Specifies the data items to provide with the event when it occurs. Data items are specified as a combination of TDataRequestType constants OR'ed together. By default, an event-specific observer interface returns the maximum possible data items that can be returned with that event. MPI clients can override this method to specify a subset of those data items to be returned with the event.

Returns:
a combination of bits, each represents a data item to provide when the event occurs.

Implements IEventObserver.

virtual void HandleEvent (  )  [pure virtual]

VM Shutdown event handler


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


Generated on Thu Mar 6 15:08:05 2008 for Martini by doxygen 1.5.5