<?xml version="1.0" encoding="utf-8"?>

<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-runtime.close">

<refnamediv>

<refname>parallel\Runtime::close</refname>

<refpurpose>Runtime Graceful Join</refpurpose>

</refnamediv>

<refsect1 role="description" audience="join">

&reftitle.description;

<methodsynopsis>

<modifier>public</modifier> <type>void</type><methodname>parallel\Runtime::close</methodname>

<void/>

</methodsynopsis>

<simpara>

Shall request that the runtime shutsdown.

</simpara>

<note>

<simpara>

Tasks scheduled for execution will be executed before the shutdown occurs.

</simpara>

</note>

</refsect1>

<refsect1 role="exceptions">

<title>Exceptions</title>

<warning>

<simpara>

Shall throw <type>parallel\Runtime\Error\Closed</type> if <type>Runtime</type> was already closed.

</simpara>

</warning>

</refsect1>

</refentry>