IMethodLeaveEventObserver Interface Reference

Observer interface for receiving Method Leave events. More...

#include <MpiAPI.h>

Inheritance diagram for IMethodLeaveEventObserver:

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


Detailed Description

The Method Leave event is sent just before the execution is about to leave a method. The event is sent upon normal exit or upon abnormal exit (exception).

The event is sent on the thread which is executing the method.

The event is guaranteed to arrive in order, meaning it will always arrive after the Method Entry event for the same method. Unless this event is disabled during execution, the MPI client can safely assume it will receive this event for each Method Entry event it received.

The event supports the following data items:


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

Method Leave event handler

Parameters:
[in] data event data. The 'validData' field indicates which members of the structure are valid.


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


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