IThreadStartEventObserver Interface Reference

Observer interface for receiving Thread Start events. More...

#include <MpiAPI.h>

Inheritance diagram for IThreadStartEventObserver:

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


Detailed Description

The Thread Start event is sent when a thread is started. The event is guaranteed to be the first event sent for the started thread. If thread information is not available when the event is sent (in this case, a Data Request for thread information will fail and return no data), the event will be sent again when the thread information becomes available.

In Java 5.0, the event is sent on the newly started thread. In Java 1.4, this is not guaranteed.

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

Thread Start 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:01 2008 for Martini by doxygen 1.5.5