mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
74 lines
2.4 KiB
XML
74 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<refentry xml:id="fiber.suspend" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Fiber::suspend</refname>
|
|
<refpurpose>Suspends execution of the current fiber</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="Fiber">
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>mixed</type><methodname>Fiber::suspend</methodname>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Suspends execution of the current fiber. The value provided to this method will be returned from the call to
|
|
<methodname>Fiber::start</methodname>, <methodname>Fiber::resume</methodname>, or
|
|
<methodname>Fiber::throw</methodname> that switched execution into the current fiber.
|
|
</para>
|
|
<para>
|
|
When the fiber is resumed, this method returns the value provided to <methodname>Fiber::resume</methodname>.
|
|
If the fiber is resumed using <methodname>Fiber::throw</methodname>, the exception given to that method will be
|
|
thrown from the call to this method.
|
|
</para>
|
|
<para>
|
|
If this method is called from outside a fiber, a <classname>FiberError</classname> will be thrown.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The value to return from the call to <methodname>Fiber::start</methodname>,
|
|
<methodname>Fiber::resume</methodname>, or <methodname>Fiber::throw</methodname> that switched execution into
|
|
the current fiber.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The value provided to <methodname>Fiber::resume</methodname>.
|
|
</para>
|
|
</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
|
|
-->
|