File: construct.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (87 lines) | stat: -rw-r--r-- 2,587 bytes parent folder | download | duplicates (2)
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?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>
   <modifier>public</modifier> <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
-->