1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Bsend_init 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Bsend_init\fP \- Builds a handle for a buffered send. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Bsend_init(void \fI*buf\fP, int\fI count\fP, MPI_Datatype\fI datatype\fP, |
---|
13 | int\fI dest\fP, int\fI tag\fP, MPI_Comm\fI comm\fP, MPI_Request\fI *request\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_BSEND_INIT(\fIBUF\fP,\fI COUNT\fP, \fIDATATYPE\fP,\fI DEST\fP,\fI TAG\fP,\fI COMM\fP,\fI REQUEST\fP, |
---|
19 | \fIIERROR\fP) |
---|
20 | <type> \fIBUF\fP(\fI*\fP) |
---|
21 | INTEGER \fICOUNT\fP,\fI DATATYPE\fP, \fIDEST\fP,\fI TAG\fP, |
---|
22 | INTEGER \fICOMM\fP,\fI REQUEST\fP,\fI IERROR |
---|
23 | |
---|
24 | .SH C++ Syntax |
---|
25 | .nf |
---|
26 | #include <mpi.h> |
---|
27 | Prequest Comm::Bsend_init(const void* \fIbuf\fP, int \fIcount\fP, const |
---|
28 | Datatype& \fIdatatype\fP, int \fIdest\fP, int \fItag\fP) const |
---|
29 | |
---|
30 | .SH INPUT PARAMETERS |
---|
31 | .ft R |
---|
32 | .TP 1i |
---|
33 | buf |
---|
34 | Initial address of send buffer (choice). |
---|
35 | .TP 1i |
---|
36 | count |
---|
37 | Number of elements sent (integer). |
---|
38 | .TP 1i |
---|
39 | datatype |
---|
40 | Type of each element (handle). |
---|
41 | .TP 1i |
---|
42 | dest |
---|
43 | Rank of destination (integer). |
---|
44 | .TP 1i |
---|
45 | tag |
---|
46 | Message tag (integer). |
---|
47 | .TP 1i |
---|
48 | comm |
---|
49 | Communicator (handle). |
---|
50 | |
---|
51 | .SH OUTPUT PARAMETERS |
---|
52 | .ft R |
---|
53 | .TP 1i |
---|
54 | request |
---|
55 | Communication request (handle). |
---|
56 | .ft R |
---|
57 | .TP 1i |
---|
58 | IERROR |
---|
59 | Fortran only: Error status (integer). |
---|
60 | |
---|
61 | .SH DESCRIPTION |
---|
62 | .ft R |
---|
63 | Creates a persistent communication request for a buffered mode send, and binds to it all the arguments of a send operation. |
---|
64 | .sp |
---|
65 | A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start. |
---|
66 | |
---|
67 | .SH ERRORS |
---|
68 | Almost 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. |
---|
69 | .sp |
---|
70 | Before the error value is returned, the current MPI error handler is |
---|
71 | 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. |
---|
72 | |
---|
73 | .SH SEE ALSO |
---|
74 | .ft R |
---|
75 | .nf |
---|
76 | MPI_Send_init |
---|
77 | MPI_Ssend_init |
---|
78 | MPI_Rsend_init |
---|
79 | MPI_Recv_init |
---|
80 | MPI_Start |
---|
81 | MPI_Startall |
---|
82 | |
---|