IHeapFilter Interface Reference

Event Filter interface for defining selectivity for Heap events. More...

#include <MpiAPI.h>

Inheritance diagram for IHeapFilter:

IEventFilter

List of all members.

Public Member Functions

virtual EFilterType Type ()
 Returns the filter type.
virtual bool ShouldNotify (SHeapFilterData &objectInfo)=0
 Invoked to determine event selectivity for a class.


Detailed Description

Event Filter interface for defining selectivity for the following events: Object Alloc and Object Free

To implement selectivity, the client defines a filter class which implements this interface, and then registers an instance of this class with MPI using the IMpi::SetEventGroupFilter method.

The MPI implementation will call the ShouldNotify method of the filter class for each new class it encounters, in order to determine whether to generate Heap events for this class.

Remarks:
- The current implementation for Java calls the filter function for each allocated object. This will be optimized in future versions.

Member Function Documentation

virtual EFilterType Type (  )  [inline, virtual]

Returns the filter type. The MPI implementation is using the function to determine the type of the filter.

Returns:
one of the filter types defined in EFilterType

Implements IEventFilter.

virtual bool ShouldNotify ( SHeapFilterData objectInfo  )  [pure virtual]

This method is implemented by the filter class and called by the MPI implementation to determine whether to report heap events for a class

Parameters:
[in] objectInfo class information
Return values:
true an implementation returns true to indicate that events should be reported for this class
false an implementation returns false to indicate that events should not be reported for this class


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


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