mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
8d666e8198
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328910 c90b9560-bf6c-de11-be94-00142212c4b1
105 lines
2.8 KiB
XML
105 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="evwatcher.keepalive" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>EvWatcher::keepalive</refname>
|
|
<refpurpose>Configures whether to keep the loop from returning</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier>
|
|
<type>bool</type>
|
|
<methodname>EvWatcher::keepalive</methodname>
|
|
<methodparam choice="opt">
|
|
<type>bool</type>
|
|
<parameter>value</parameter>
|
|
</methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Configures whether to keep the loop from returning. With keepalive
|
|
<parameter>value</parameter>
|
|
set to &false; the watcher won't keep
|
|
<methodname>Ev::run</methodname>
|
|
/
|
|
<methodname>EvLoop::run</methodname>
|
|
from returning even though the watcher is active.
|
|
</para>
|
|
<para>
|
|
Watchers have keepalive
|
|
<parameter>value</parameter>
|
|
&true; by default.
|
|
</para>
|
|
<para>
|
|
Clearing keepalive status is useful when returning from
|
|
<methodname>Ev::run</methodname>
|
|
/
|
|
<methodname>EvLoop::run</methodname>
|
|
just because of the watcher is undesirable. It could be a long running UDP
|
|
socket watcher or so.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>value</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
With keepalive
|
|
<parameter>value</parameter>
|
|
set to &false; the watcher won't keep
|
|
<methodname>Ev::run</methodname>
|
|
/
|
|
<methodname>EvLoop::run</methodname>
|
|
from returning even though the watcher is active.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the previous state.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Register an I/O watcher for some UDP socket but do not keep the
|
|
event loop from running just because of that watcher.</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$udp_socket = ...
|
|
$udp_watcher = new EvIo($udp_socket, Ev::READ, function () { /* ... */ });
|
|
$udp_watcher->keepalive(FALSE);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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
|
|
-->
|