1 | .\"Copyright 2007-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Open_port 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Open_port\fP \- Establishes a network address for a server to accept connections from clients. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Open_port(MPI_Info \fIinfo\fP, char *\fIport_name\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_OPEN_PORT(\fIINFO, PORT_NAME, IERROR\fP) |
---|
18 | CHARACTER*(*) \fIPORT_NAME\fP |
---|
19 | INTEGER \fIINFO, IERROR\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void MPI::Open_port(const MPI::Info& \fIinfo\fP, char* \fIport_name\fP) |
---|
25 | |
---|
26 | .SH INPUT PARAMETER |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | info |
---|
30 | Options on how to establish an address (handle). No options currently supported. |
---|
31 | |
---|
32 | .SH OUTPUT PARAMETERS |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | port_name |
---|
36 | Newly established port (string). |
---|
37 | .TP 1i |
---|
38 | IERROR |
---|
39 | Fortran only: Error status (integer). |
---|
40 | |
---|
41 | .SH DESCRIPTION |
---|
42 | .ft R |
---|
43 | MPI_Open_port establishes a network address, encoded in the \fIport_name\fP string, at which the server will be able to accept connections from clients. \fIport_name\fP is supplied by the system. |
---|
44 | .sp |
---|
45 | MPI copies a system-supplied port name into \fIport_name\fP. \fIport_name\fP identifies the newly opened port and can be used by a client to contact the server. The maximum size string that may be supplied by the system is MPI_MAX_PORT_NAME. |
---|
46 | |
---|
47 | .SH SUPPORTED INFO KEYS |
---|
48 | None. |
---|
49 | |
---|
50 | .SH ERRORS |
---|
51 | 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. |
---|
52 | .sp |
---|
53 | Before the error value is returned, the current MPI error handler is |
---|
54 | 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. |
---|
55 | |
---|
56 | .SH SEE ALSO |
---|
57 | MPI_Comm_accept |
---|
58 | MPI_Comm_connect |
---|
59 | .br |
---|
60 | |
---|