IObjectFreeEventObserver Interface Reference

Observer interface for receiving Object Free events. More...

#include <MpiAPI.h>

Inheritance diagram for IObjectFreeEventObserver:

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 (SHeapEventData &data)=0
 Event Handler.


Detailed Description

The Object Free event is sent when the garbage collector frees an object.

After an object is deallocated, its id is not longer valid and cannot be used in a data request.

The data items supported by this event are specified by the default implementation of the EventDataTypes method. Note, however, that only data items requested with the Object Allocated event will be available to this event observer. In other words, data items specified with this observer that are not specified in the Object Allocated event observer will be ignored.

Remarks:
- In Java, only the IMpi::GetClassInfo data request can be used in the event handler. Other data requests may cause the JVM to crash.

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 ( SHeapEventData data  )  [pure virtual]

Object Alloc event handler

Parameters:
[in] data event data.


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


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