File: MPI_Open_port.3.rst

package info (click to toggle)
openmpi 5.0.8-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 201,692 kB
  • sloc: ansic: 613,078; makefile: 42,351; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (86 lines) | stat: -rw-r--r-- 1,668 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
.. _mpi_open_port:


MPI_Open_port
=============

.. include_body

:ref:`MPI_Open_port` |mdash| Establishes a network address for a server to accept
connections from clients.


SYNTAX
------


C Syntax
^^^^^^^^

.. code-block:: c

   #include <mpi.h>

   int MPI_Open_port(MPI_Info info, char *port_name)


Fortran Syntax
^^^^^^^^^^^^^^

.. code-block:: fortran

   USE MPI
   ! or the older form: INCLUDE 'mpif.h'
   MPI_OPEN_PORT(INFO, PORT_NAME, IERROR)
   	CHARACTER*(*)	PORT_NAME
   	INTEGER		INFO, IERROR


Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^

.. code-block:: fortran

   USE mpi_f08
   MPI_Open_port(info, port_name, ierror)
   	TYPE(MPI_Info), INTENT(IN) :: info
   	CHARACTER(LEN=MPI_MAX_PORT_NAME), INTENT(OUT) :: port_name
   	INTEGER, OPTIONAL, INTENT(OUT) :: ierror


INPUT PARAMETER
---------------
* ``info``: Options on how to establish an address (handle). No options currently supported.

OUTPUT PARAMETERS
-----------------
* ``port_name``: Newly established port (string).
* ``ierror``: Fortran only: Error status (integer).

DESCRIPTION
-----------

:ref:`MPI_Open_port` establishes a network address, encoded in the *port_name*
string, at which the server will be able to accept connections from
clients. *port_name* is supplied by the system.

MPI copies a system-supplied port name into *port_name*. *port_name*
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.


SUPPORTED INFO KEYS
-------------------

None.


ERRORS
------

.. include:: ./ERRORS.rst

.. seealso::
   * :ref:`MPI_Comm_accept`
   * :ref:`MPI_Comm_connect`