File: MPI_Session_create_errhandler.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 (85 lines) | stat: -rw-r--r-- 2,077 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
.. _mpi_session_create_errhandler:

MPI_Session_create_errhandler
=============================

.. include_body

:ref:`MPI_Session_create_errhandler` |mdash| Creates an error handler that can be
attached to sessions

SYNTAX
------

C Syntax
^^^^^^^^

.. code-block:: c

   #include <mpi.h>

   int MPI_Session_create_errhandler(MPI_Session_errhandler_function *function,
       MPI_Errhandler *errhandler)

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

.. code-block:: fortran

   USE MPI
   ! or the older form: INCLUDE 'mpif.h'

   MPI_SESSION_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
       EXTERNAL    FUNCTION
       INTEGER ERRHANDLER, IERROR

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

.. code-block:: fortran

   USE mpi_f08

   MPI_Session_create_errhandler(session_errhandler_fn, errhandler, ierror)
       PROCEDURE(MPI_Session_errhandler_function) :: session_errhandler_fn
       TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
       INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETER
---------------

* ``function`` : User-defined error handling procedure (function).

OUTPUT PARAMETERS
-----------------

* ``errhandler`` : MPI error handler (handle).
* ``ierror`` : Fortran only: Error status (integer).

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

:ref:`MPI_Session_create_errhandler` creates an error handler that can be
attached to sessions. This ``function`` is identical to
:ref:`MPI_Errhandler_create`, the use of which is deprecated. In C, the
user routine should be a ``function`` of type
``MPI_Session_errhandler_function``, which is defined as

.. code-block:: c

   typedef void MPI_Session_errhandler_function(MPI_Session *, int *, ...);

The first argument is the session in use. The second is the error code
to be returned by the MPI routine that raised the error. This typedef
replaces ``MPI_Handler_function``, the use of which is deprecated. In
Fortran, the user routine should be of this form:

.. code-block:: fortran

   SUBROUTINE SESSION_ERRHANDLER_FUNCTION(SESSION, ERROR_CODE, ...)
      INTEGER SESSION, ERROR_CODE

ERRORS
------

.. include:: ./ERRORS.rst