mpi_start(3openmpi) [osx man page]

MPI_Start(3OpenMPI)													       MPI_Start(3OpenMPI)

NAME

       MPI_Start - Initiates a communication using a persistent request handle.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Start(MPI_Request *request)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_START(REQUEST, IERROR)
	    INTEGER   REQUEST, IERROR

C++ Syntax
       #include <mpi.h>
       void Prequest::Start()

INPUT PARAMETER

       request	 Communication request (handle).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start.

       The  argument,  request,  is  a	handle	returned  by  one of the persistent communication-request initialization functions (MPI_Send_init,
       MPI_Bsend_init,	MPI_Ssend_init, MPI_Rsend_init, MPI_Recv_init). The associated request should be inactive and becomes active once the call
       is made.

       If  the	request is for a send with ready mode, then a matching receive should be posted before the call is made. From the time the call is
       made until after the operation completes, the communication buffer should not be accessed.

       The call is local, with semantics similar to the nonblocking communication operations (see Section 3.7 in the MPI-1 Standard,  "Nonblocking
       Communication.")  That  is, a call to MPI_Start with a request created by MPI_Send_init starts a communication in the same manner as a call
       to MPI_Isend; a call to MPI_Start with a request created by MPI_Bsend_init starts  a  communication  in	the  same  manner  as  a  call	to
       MPI_Ibsend; and so on.

ERRORS

       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::ERRORS_THROW_EXCEPTIONS, 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 MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN  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

       MPI_Bsend_init
       MPI_Rsend_init
       MPI_Send_init
       MPI_Sssend_init
       MPI_Recv_init
       MPI_Startall

Open MPI 1.2							  September 2006					       MPI_Start(3OpenMPI)

MPI_Start(3)							      LAM/MPI							      MPI_Start(3)

NAME

       MPI_Start -  Initiates a communication with a persistent request handle

SYNOPSIS

       #include <mpi.h>
       int MPI_Start(MPI_Request *req)

INPUT PARAMETER

       req    - communication request (handle)

NOTES

       This function starts a communication that was previously initialized with any of the MPI_*_init functions.

NOTES FOR FORTRAN

       All  MPI  routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list.  ierr
       is an integer and has the same meaning as the return value of the routine in C.	In Fortran, MPI routines are subroutines, and are  invoked
       with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       If an error occurs in an MPI function, the current MPI error handler is called to handle it.  By default, this error handler aborts the MPI
       job.  The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause  error
       values  to  be  returned  (in  C and Fortran; this error handler is less useful in with the C++ MPI bindings.  The predefined error handler
       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered).  Note that MPI does not guarantee that an MPI
       program can continue past an error.

       All  MPI  routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in
       the last argument.  The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing  exceptions	of
       type MPI::Exception (but not by default).  Exceptions are only thrown if the error value is not MPI::SUCCESS
	.

       Note  that  if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover
       what the actual error value was.
       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class.  This is typically a NULL pointer	or
	      other such error.
       MPI_ERR_REQUEST
	      - Invalid MPI_Request ; either null or, MPI_REQUEST_NULL , in the case of a MPI_Start or MPI_Startall , not a persistent request.

SEE ALSO

       MPI_Bsend_init,	 MPI_Request_free,  MPI_Rsend_init,  MPI_Send_init,  MPI_Ssend_init,  MPI_Startall,  MPI_Test,	MPI_Testall,  MPI_Testany,
       MPI_Testsome, MPI_Wait, MPI_Waitall, MPI_Waitany, MPI_Waitsome

MORE INFORMATION

       For more information, please see the official MPI Forum web site, which contains the text of both the MPI-1  and  MPI-2	standards.   These
       documents contain detailed information about each MPI function (most of which is not duplicated in these man pages).

       http://www.mpi-forum.org/

ACKNOWLEDGEMENTS

       The LAM Team would like the thank the MPICH Team for the handy program to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow-
       ing/sowing.tar.gz ), the initial formatting, and some initial text for most of the MPI-1 man pages.

LOCATION

       start.c

LAM
/MPI 6.5.8							    11/10/2002							      MPI_Start(3)