source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Start.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 2.5 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Start 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Start\fP \- Initiates a communication using a persistent request handle.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Start(MPI_Request *\fIrequest\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_START(\fIREQUEST, IERROR\fP)
18        INTEGER \fIREQUEST, IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23void Prequest::Start()
24
25.SH INPUT PARAMETER
26.ft R
27.TP 1i
28request
29Communication request (handle).
30
31.SH OUTPUT PARAMETER
32.ft R
33.TP 1i
34IERROR
35Fortran only: Error status (integer).
36
37.SH DESCRIPTION
38.ft R
39A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start.
40.sp
41The 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.
42.sp
43If 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.
44.sp
45The 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.
46
47.SH ERRORS
48Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions 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.
49.sp
50Before the error value is returned, the current MPI error handler is
51called. 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. 
52
53.SH SEE ALSO
54.ft R
55.sp
56MPI_Bsend_init
57.br
58MPI_Rsend_init
59.br
60MPI_Send_init
61.br
62MPI_Sssend_init
63.br
64MPI_Recv_init
65.br
66MPI_Startall
67
68
Note: See TracBrowser for help on using the repository browser.