MPIWait

Definition

typedef enum {
    MPIWaitFOREVER = -1,
    MPIWaitPOLL = 0,
    MPIWaitMSEC
} MPIWait;

Description

MPIWait enumerations define basic wait times for certain MPI methods.

MPIWaitFOREVER Makes MPI methods wait forever for an event to occur before returning.
MPIWaitPOLL Makes MPI methods see if a certain event has occurred. If an event has not occurred, then the MPI method will generally return immediately returning the value MPIMessageTIMEOUT.
MPIWaitMSEC Defines a period of one millisecond. If used alone, this will make MPI methods wait for one millisecond for an event occurs before returning. One can pass an an agument a multiple of MPIWaitMSEC to make MPI methods wait longer periods of time. For example, the following statement will make mpiPlatformKey wait 5 milliseconds for a user keystroke: mpiPlatformKey( 5 * MPIWaitMSEC ); If an event does not occur within the specified time, MPI methods will generally return the value MPIMessageTIMEOUT.

Warning

The MPI depends on the ability of the operating system it is running on to be able to activate threads or put threads to sleep for a specified period of time in order for these times to be accurate. Microsoft Windows platforms are not real-time operating systems and are known to be unable to activate threads any quicker than 10 milliseconds. If you encounter a timing problem, it is likely an operating system timing issue.

See Also

mpiControlInterruptWait | mpiNotifyEventWait | mpiObjectTimeoutGet | mpiObjectTimeoutSet | mpiPlatformKey