-
Notifications
You must be signed in to change notification settings - Fork 725
/
kill.xml
62 lines (56 loc) · 1.5 KB
/
kill.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="parallel-runtime.kill" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>parallel\Runtime::kill</refname>
<refpurpose>Runtime Join</refpurpose>
</refnamediv>
<refsect1 role="description" audience="join">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>parallel\Runtime::kill</methodname>
<void />
</methodsynopsis>
<para>
Shall attempt to force the runtime to shutdown.
</para>
<note>
<para>
Tasks scheduled for execution will not be executed, the currently running task shall be interrupted.
</para>
</note>
<warning>
<para>
Internal function calls in progress cannot be interrupted.
</para>
</warning>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
Shall throw <type>parallel\Runtime\Error\Closed</type> if <type>Runtime</type> was closed.
</para>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->