php-doc-en/reference/zmq/zmqdevice/construct.xml
Mikko Koppanen 6d56cf6f44 Added documentation for the devices.
Notes about the upcoming 1.1.0 release


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332005 c90b9560-bf6c-de11-be94-00142212c4b1
2013-10-27 13:34:12 +00:00

87 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="zmqdevice.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZMQDevice::__construct</refname>
<refpurpose>Construct a new device</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>ZMQDevice::__construct</methodname>
<methodparam><type>ZMQSocket</type><parameter>frontend</parameter></methodparam>
<methodparam><type>ZMQSocket</type><parameter>backend</parameter></methodparam>
<methodparam choice="opt"><type>ZMQSocket</type><parameter>listener</parameter></methodparam>
</methodsynopsis>
<para>
"ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you care to define above the message and socket layers." -- zguide
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>frontend</parameter></term>
<listitem>
<para>
Frontend parameter for the devices. Usually where there messages
are coming.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>backend</parameter></term>
<listitem>
<para>
Backend parameter for the devices. Usually where there messages
going to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>listener</parameter></term>
<listitem>
<para>
Listener socket, which receives a copy of all messages going both directions.
The type of this socket should be SUB, PULL or DEALER.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Call to this method will prepare the device. Usually devices are very long
running processes so running this method from interactive script is not recommended. This
method throw ZMQDeviceException if the device cannot be started.
</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
-->