MPIIrecv(3OpenMPI) MPIIrecv(3OpenMPI)

NAME
       MMPPIIIIrreeccvv - Starts a standard-mode, nonblocking receive.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIIrecv(void *buf, int count, MPIDatatype datatype,
               int source, int tag, MPIComm comm, MPIRequest *request)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIIRECV(BUF, COUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST,
                 IERROR)
                BUF(*)
            INTEGER   COUNT, DATATYPE, SOURCE, TAG, COMM, REQUEST, IERROR


CC++++ SSyynnttaaxx
       #include 
       Request Comm::Irecv(void* buf, int count, const Datatype&
            datatype, int source, int tag) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       buf       Initial address of receive buffer (choice).

       count     Number of elements in receive buffer (integer).

       datatype  Datatype of each receive buffer element (handle).

       source    Rank of source (integer).

       tag       Message tag (integer).

       comm      Communicator (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       request   Communication request (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Nonblocking calls allocate a communication request object and associate
       it with the request handle (the argument request). The request  can  be
       used  later  to  query  the status of the communication or wait for its
       completion.

       A nonblocking receive call indicates that the system may start  writing
       data  into  the receive buffer. The receiver should not access any part
       of the receive buffer after a nonblocking receive operation is  called,
       until the receive completes.

       A  receive  request  can  be  determined being completed by calling the
       MPIWait, MPIWaitany, MPITest, or MPITestany with  request  returned
       by this function.


EERRRROORRSS
       Almost  all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last  argument.  C++  func-
       tions  do  not  return  errors.  If the default error handler is set to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before  the  error  value is returned, the current MPI error handler is
       called. By default, this error handler aborts the MPI job,  except  for
       I/O   function   errors.   The   error  handler  may  be  changed  with
       MPICommseterrhandler; 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 continue past an error.


SEE ALSO
       MPIRecv MPIProbe MPITest MPITestany MPIWait MPIWaitany




Open MPI 1.2                    September 2006             MPIIrecv(3OpenMPI)