[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/zmq/zmqdevice/_construct.xml_getidletimeout.xml_
From: Mikko_Koppanen <mkoppanen () php ! net>
Date: 2013-10-27 13:34:12
Message-ID: svn-mkoppanen-1382880852-332005-1395765945 () svn ! php ! net
[Download RAW message or body]
mkoppanen Sun, 27 Oct 2013 13:34:12 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=332005
Log:
Added documentation for the devices.
Notes about the upcoming 1.1.0 release
Changed paths:
U phpdoc/en/trunk/reference/zmq/zmqdevice/construct.xml
A phpdoc/en/trunk/reference/zmq/zmqdevice/getidletimeout.xml
A phpdoc/en/trunk/reference/zmq/zmqdevice/gettimertimeout.xml
U phpdoc/en/trunk/reference/zmq/zmqdevice/setidlecallback.xml
U phpdoc/en/trunk/reference/zmq/zmqdevice/setidletimeout.xml
A phpdoc/en/trunk/reference/zmq/zmqdevice/settimercallback.xml
A phpdoc/en/trunk/reference/zmq/zmqdevice/settimertimeout.xml
["svn-diffs-332005.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/reference/zmq/zmqdevice/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/zmq/zmqdevice/construct.xml 2013-10-27 13:17:39 UTC \
(rev 332004)
+++ phpdoc/en/trunk/reference/zmq/zmqdevice/construct.xml 2013-10-27 13:34:12 UTC \
(rev 332005) @@ -46,7 +46,7 @@
<listitem>
<para>
Listener socket, which receives a copy of all messages going both directions.
- The type of this socket should be PUB, PUSH or DEALER.
+ The type of this socket should be SUB, PULL or DEALER.
</para>
</listitem>
</varlistentry>
Added: phpdoc/en/trunk/reference/zmq/zmqdevice/getidletimeout.xml
===================================================================
--- phpdoc/en/trunk/reference/zmq/zmqdevice/getidletimeout.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/zmq/zmqdevice/getidletimeout.xml 2013-10-27 13:34:12 \
UTC (rev 332005) @@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="zmqdevice.getidletimeout" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>ZMQDevice::getIdleTimeout</refname>
+ <refpurpose>Get the idle timeout</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>ZMQDevice</type><methodname>ZMQDevice::getIdleTimeout</methodname> + <void/>
+ </methodsynopsis>
+ <para>
+ Gets the idle callback timeout value. Added in ZMQ extension version 1.1.0.
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ This method returns the idle callback timeout value.
+ </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
+-->
Added: phpdoc/en/trunk/reference/zmq/zmqdevice/gettimertimeout.xml
===================================================================
--- phpdoc/en/trunk/reference/zmq/zmqdevice/gettimertimeout.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/zmq/zmqdevice/gettimertimeout.xml 2013-10-27 13:34:12 \
UTC (rev 332005) @@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="zmqdevice.gettimertimeout" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>ZMQDevice::getTimerTimeout</refname>
+ <refpurpose>Get the timer timeout</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>ZMQDevice</type><methodname>ZMQDevice::getTimerTimeout</methodname> + <void/>
+ </methodsynopsis>
+ <para>
+ Gets the timer callback timeout value. Added in ZMQ extension version 1.1.0.
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ This method returns the timer timeout value.
+ </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
+-->
Modified: phpdoc/en/trunk/reference/zmq/zmqdevice/setidlecallback.xml
===================================================================
--- phpdoc/en/trunk/reference/zmq/zmqdevice/setidlecallback.xml 2013-10-27 13:17:39 \
UTC (rev 332004)
+++ phpdoc/en/trunk/reference/zmq/zmqdevice/setidlecallback.xml 2013-10-27 13:34:12 \
UTC (rev 332005) @@ -12,11 +12,15 @@
<methodsynopsis>
<modifier>public</modifier> \
<type>ZMQDevice</type><methodname>ZMQDevice::setIdleCallback</methodname> \
<methodparam><type>callable</type><parameter>cb_func</parameter></methodparam> + \
<methodparam><type>integer</type><parameter>timeout</parameter></methodparam> + \
<methodparam choice="opt"><type>mixed</type><parameter>user_data</parameter></methodparam>
</methodsynopsis>
<para>
Sets the idle callback function. If idle timeout is defined the idle callback \
function shall be called if the internal poll loop times out without events. If the \
callback function returns false or a value that evaluates to false the device is \
stopped. +
+ The callback function signature is callback (mixed $user_data).
</para>
</refsect1>
@@ -27,10 +31,31 @@
<term><parameter>cb_func</parameter></term>
<listitem>
<para>
- Callback function
+ Callback function to invoke when the device is idle. Returning false
+ or a value that evaluates to false from this function will cause the
+ device to stop.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem>
+ <para>
+ How often to invoke the idle callback in milliseconds. The idle callback is \
invoked + periodically when there is no activity on the device.
+ The timeout value guarantees that there is at least this amount of \
milliseconds between + invocations of the callback function.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter></term>
+ <listitem>
+ <para>
+ Additional data to pass to the callback function.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/zmq/zmqdevice/setidletimeout.xml
===================================================================
--- phpdoc/en/trunk/reference/zmq/zmqdevice/setidletimeout.xml 2013-10-27 13:17:39 \
UTC (rev 332004)
+++ phpdoc/en/trunk/reference/zmq/zmqdevice/setidletimeout.xml 2013-10-27 13:34:12 \
UTC (rev 332005) @@ -14,7 +14,8 @@
<methodparam><type>integer</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
<para>
- Sets the internal poll timeout value.
+ Sets the idle callback timeout value. The idle callback is invoked periodically \
when the device is + idle.
</para>
</refsect1>
@@ -25,7 +26,7 @@
<term><parameter>timeout</parameter></term>
<listitem>
<para>
- The poll timeout value.
+ The idle callback timeout value.
</para>
</listitem>
</varlistentry>
Added: phpdoc/en/trunk/reference/zmq/zmqdevice/settimercallback.xml
===================================================================
--- phpdoc/en/trunk/reference/zmq/zmqdevice/settimercallback.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/zmq/zmqdevice/settimercallback.xml 2013-10-27 13:34:12 \
UTC (rev 332005) @@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="zmqdevice.settimercallback" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>ZMQDevice::setTimerCallback</refname>
+ <refpurpose>Set the timer callback function</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>ZMQDevice</type><methodname>ZMQDevice::setTimerCallback</methodname> + \
<methodparam><type>callable</type><parameter>cb_func</parameter></methodparam> + \
<methodparam><type>integer</type><parameter>timeout</parameter></methodparam> + \
<methodparam choice="opt"><type>mixed</type><parameter>user_data</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Sets the timer callback function. The timer callback will be invoked after \
timeout has + passed. The difference between idle and timer callbacks are that idle \
callback is invoked + only when the device is idle.
+
+ The callback function signature is callback (mixed $user_data). Added in ZMQ \
extension version 1.1.0. + </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cb_func</parameter></term>
+ <listitem>
+ <para>
+ Callback function to invoke when the device is idle. Returning false
+ or a value that evaluates to false from this function will cause the
+ device to stop.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem>
+ <para>
+ How often to invoke the idle callback in milliseconds. The idle callback is \
invoked + periodically when there is no activity on the device.
+ The timeout value guarantees that there is at least this amount of \
milliseconds between + invocations of the callback function.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter></term>
+ <listitem>
+ <para>
+ Additional data to pass to the callback function.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ On success this method returns the current object.
+ </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
+-->
Added: phpdoc/en/trunk/reference/zmq/zmqdevice/settimertimeout.xml
===================================================================
--- phpdoc/en/trunk/reference/zmq/zmqdevice/settimertimeout.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/zmq/zmqdevice/settimertimeout.xml 2013-10-27 13:34:12 \
UTC (rev 332005) @@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="zmqdevice.settimertimeout" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>ZMQDevice::setTimerTimeout</refname>
+ <refpurpose>Set the timer timeout</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>ZMQDevice</type><methodname>ZMQDevice::setTimerTimeout</methodname> + \
<methodparam><type>integer</type><parameter>timeout</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Sets the timer callback timeout value. The timer callback is invoked periodically \
if it's set. + Added in ZMQ extension version 1.1.0.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>timeout</parameter></term>
+ <listitem>
+ <para>
+ The timer callback timeout value.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ On success this method returns the current object.
+ </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
+-->
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic