mpiObjectTimeoutSet

Declaration

	long mpiObjectTimeoutSet(MPIHandle handle, MPIWait timeout)
	Required Header: stdmpi.h

Description

mpiObjectTimeoutSet sets the timeout value for an object (handle) to timeout.

The timeout value is used in a multi-threaded environment when an MPI function must block to wait for a shared resource to become available. The default timeout value is MPIWaitFOREVER.

*If "timeout" is*	Then
MPIWaitFOREVER	ObjectTimeoutSet will wait until the resource becomes available
MPIWaitPOLL	ObjectTimeoutSet will not wait for the resource to become available. If the shared resource is not available, a timeout will be considered to have occurred.
a value	ObjectTimeoutSet will wait timeout milliseconds for the resource to become available

Return Values
MPIMessageOK
MPIMessageTIMEOUT