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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="zmqcontext.getsocket" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZMQContext::getSocket</refname>
<refpurpose>Create a new socket</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>ZMQSocket</type><methodname>ZMQContext::getSocket</methodname>
<methodparam><type>integer</type><parameter>type</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>persistent_id</parameter><initializer>null</initializer></methodparam>
<methodparam choice="opt"><type>callback</type><parameter>on_new_socket</parameter><initializer>null</initializer></methodparam>
</methodsynopsis>
<para>
Shortcut for creating new sockets from the context. If the context is not persistent the <parameter>persistent_id</parameter>
parameter is ignored and the socket falls back to being non-persistent. The <parameter>on_new_socket</parameter> is called only
when a new underlying socket structure is created.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
<constant>ZMQ::SOCKET_*</constant> constant to specify socket type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>persistent_id</parameter></term>
<listitem>
<para>
If <parameter>persistent_id</parameter> is specified the socket will be persisted over multiple requests.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>on_new_socket</parameter></term>
<listitem>
<para>
Callback function, which is executed when a new socket structure is created. This function does not get invoked
if the underlying persistent connection is re-used. The callback takes ZMQSocket and persistent_id as two arguments.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>ZMQContext</function> example</title>
<para>
Basic usage
</para>
<programlisting role="php">
<![CDATA[
<?php
/* Allocate a new context */
$context = new ZMQContext();
/* Create a new socket */
$socket = $context->getSocket(ZMQ::SOCKET_REQ, 'my sock');
/* Connect the socket */
$socket->connect("tcp://example.com:1234");
/* Send a request */
$socket->send("Hello there");
/* Receive back the response */
$message = $socket->recv();
echo "Received message: {$message}\n";
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a ZMQSocket object on success. Throws ZMQSocketException on error.
</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
-->
|
