MPITestall(3OpenMPI) MPITestall(3OpenMPI)

NAME
       MMPPIITTeessttaallll - Tests for the completion of all previously initiated com-
       munications in a list.


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


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


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

       static bool Request::Testall(int count, Request arrayofrequests[])


IINNPPUUTT PPAARRAAMMEETTEERRSS
       count     Lists length (integer).

       arrayofrequests
                 Array of requests (array of handles).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       flag      True if  previously  initiated  communications  are  complete
                 (logical.)

       arrayofstatuses
                 Array of status objects (array of status).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Returns  flag  = true if all communications associated with active han-
       dles in the array have completed (this includes the case where no  han-
       dle in the list is active). In this case, each status entry that corre-
       sponds to an active handle request is set to the status of  the  corre-
       sponding  communication;  if the request was allocated by a nonblocking
       communication call then it is deallocated, and the  handle  is  set  to
       MPIREQUESTNULL. Each status entry that corresponds to a null or inac-
       tive handle is set to empty.

       Otherwise, flag = false is returned, no request  is  modified  and  the
       values  of the status entries are undefined. This is a local operation.

       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.

       Errors that occurred during the execution of MPITestall are handled in
       the same manner as errors in MPIWaitall.


NNOOTTEE
       flag is true only if all requests have completed.  Otherwise,  flag  is
       false, and neither arrayofrequests nor arrayofstatuses is modified.


EERRRROORRSS
       For each invocation of MPITestall, 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  MPITestall  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
       MPITestany
       MPITestsome
       MPIWait
       MPIWaitall
       MPIWaitany
       MPIWaitsome
       MPIWinseterrhandler




Open MPI 1.2                    September 2006           MPITestall(3OpenMPI)