MPIWaitall(3OpenMPI) MPIWaitall(3OpenMPI)

NAME
       MMPPIIWWaaiittaallll - Waits for all given communications to complete.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIWaitall(int count, MPIRequest *arrayofrequests,
            MPIStatus *arrayofstatuses)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIWAITALL(COUNT, ARRAYOFREQUESTS, ARRAYOFSTATUSES, IERROR)
            INTEGER   COUNT, ARRAYOFREQUESTS(*)
            INTEGER   ARRAYOFSTATUSES(MPISTATUSSIZE,*), IERROR


CC++++ SSyynnttaaxx
       #include 
       static void Request::Waitall(int count, Request arrayofrequests[],
            Status arrayofstatuses[])

       static void Request::Waitall(int count, Request arrayofrequests[])


IINNPPUUTT PPAARRAAMMEETTEERRSS
       count     Lists length (integer).

       arrayofrequests
                 Array of requests (array of handles).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       arrayofstatuses
                 Array of status objects (array of status).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Blocks  until  all communication operations associated with active han-
       dles in the list complete, and returns the status of all  these  opera-
       tions  (this  includes the case where no handle in the list is active).
       Both arrays have the same number of valid entries.  The  ith  entry  in
       arrayofstatuses  is  set  to  the return status of the ith operation.
       Requests that were created by nonblocking communication operations  are
       deallocated,  and  the  corresponding  handles  in the array are set to
       MPIREQUESTNULL. The list may contain null or  inactive  handles.  The
       call sets to empty the status of each such entry.

       The   error-free  execution  of  MPIWaitall(count,  arrayofrequests,
       arrayofstatuses)  has  the  same   effect   as   the   execution   of
       MPIWait(&arrayofrequest[i],        &arrayofstatuses[i]),       for
       i=0,...,count-1, in some arbitrary order. MPIWaitall with an array  of
       length 1 is equivalent to MPIWait.

       When one or more of the communications completed by a call to MPIWait-
       all fail, it is desirable to return specific information on each commu-
       nication.  The  function MPIWaitall will return in such case the error
       code MPIERRINSTATUS and will set the error field of each status to a
       specific error code. This code will be MPISUCCESS if the specific com-
       munication completed; it will be another  specific  error  code  if  it
       failed;  or it can be MPIERRPENDING if it has neither failed nor com-
       pleted. The function MPIWaitall will return MPISUCCESS if no  request
       had  an error, or will return another error code if it failed for other
       reasons (such as invalid arguments). In such cases, it will not  update
       the error fields of the statuses.

       If  your  application  does  not  need to examine the arrayofstatuses
       field, you can save resources by using the predefined constant MPISTA-
       TUSESIGNORE  can  be used as a special value for the arrayofstatuses
       argument.


EERRRROORRSS
       For each invocation of MPIWaitall, if one or more requests generate an
       MPI exception, only the first MPI request that caused an exception will
       be passed to its corresponding error handler.  No other error  handlers
       will be invoked (even if multiple requests generated exceptions).  How-
       ever, all requests that generate an  exception  will  have  a  relevant
       error  code  set  in  the  corresponding status.MPIERROR field (unless
       MPIIGNORESTATUSES was used).

       The default error handler aborts the MPI job, except for  I/O  function
       errors.  The error handler may be changed with MPICommseterrhandler,
       MPIFileseterrhandler, or MPIWinseterrhandler  (depending  on  the
       type  of  MPI  handle  that  generated the MPI request); the predefined
       error handler MPIERRORSRETURN may be used to cause error values to be
       returned. Note that MPI does not guarantee that an MPI program can con-
       tinue past an error.

       If the invoked error  handler  allows  MPIWaitall  to  return  to  the
       caller,  the value MPIERRINSTATUS will be returned in the C and For-
       tran   bindings.    In   C++,   if   the   predefined   error   handler
       MPI::ERRORSTHROWEXCEPTIONS is used, the value MPI::ERRINSTATUS will
       be contained in the MPI::Exception object.   The  MPIERROR  field  can
       then be examined in the array of returned statuses to determine exactly
       which request(s) generated an exception.


SEE ALSO
       MPICommseterrhandler
       MPIFileseterrhandler
       MPITest
       MPITestall
       MPITestany
       MPITestsome
       MPIWait
       MPIWaitany
       MPIWaitsome
       MPIWinseterrhandler




Open MPI 1.2                    September 2006           MPIWaitall(3OpenMPI)