NAME

MPI_Waitany - Wait until a request in an array of requests to complete

SYNOPSIS

#include <mpi.h> 
int MPI_Waitany(int count , MPI_Request *request_array , int *index , MPI_Status *status ); 
#include <pmpi.h> 
int PMPI_Waitany(int count , MPI_Request *request_array , int *index , MPI_Status *status ); 

INPUT PARAMETERS

count - number of requests in array (integer)

request_array - array of requests to check (array of handles)

OUTPUT PARAMETERS

index - index of first completed request (boolean)

status - status of first completed request (structure)

DESCRIPTION

The MPI_Waitany() function is used to wait for a request in an array of requests to complete.

The index of the first completed request will be stored in index . If that request is a receive, then the original tag and source of a recieved message are stored in the MPI_TAG and MPI_SOURCE fields of status respectively. If the received message has been truncated then MPI_ERROR will be set to be MPI_ERR_TRUNCATE. One additional field holds the total size of the message in bytes. If either a send or receive is successfully cancelled, then MPI_ERROR will contain MPI_ERR_CANCEL. Otherwise, it will be set to MPI_ERR_SUCCESS. If status is MPI_STATUS_IGNORE then this information will not be stored.

Only the first completed request is marked done, and will have a status output. The other requests are untouched, and can be completed in another call to a test or wait function.

PMPI_Waitany() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_COUNT - Invalid array size;

MPI_ERR_ARG - Invalid pointer;

MPI_ERR_REQUEST - Invalid request.

SEE ALSO

MPI_Probe (3) MPI_Isend (3) MPI_Irecv (3) MPI_Wait (3) MPI_Waitall (3) MPI_Waitsome (3) MPI_Test (3)

• Lockless
• MPI Documentation
• MPI_Waitany