mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 07:18:55 +00:00
ab56145968
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331941 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3.5 KiB
XML
130 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="zmqsocket.recv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ZMQSocket::recv</refname>
|
|
<refpurpose>Receives a message</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>string</type><methodname>ZMQSocket::recv</methodname>
|
|
<methodparam choice="opt"><type>integer</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Receive a message from a socket. By default receiving will block until a message is available unless
|
|
<constant>ZMQ::MODE_NOBLOCK</constant> flag is used. <constant>ZMQ::SOCKOPT_RCVMORE</constant>
|
|
socket option can be used for receiving multi-part messages. See <function>ZMQSocket::setSockOpt</function>
|
|
for more information.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Pass mode flags to receive multipart messages or non-blocking operation.
|
|
See <constant>ZMQ::MODE_*</constant> constants.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A send/recv example</title>
|
|
<para>
|
|
Non-blocking send / receive
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
/* Create new queue object, there needs to be a server at the other end */
|
|
$queue = new ZMQSocket(new ZMQContext(), ZMQ::SOCKET_REQ);
|
|
$queue->connect("tcp://127.0.0.1:5555");
|
|
|
|
/* Assign socket 1 to the queue, send and receive */
|
|
$retries = 5;
|
|
$sending = true;
|
|
|
|
/* Start a loop */
|
|
do {
|
|
try {
|
|
/* Try to send / receive */
|
|
if ($sending) {
|
|
echo "Sending message\n";
|
|
$queue->send("This is a message", ZMQ::MODE_NOBLOCK);
|
|
$sending = false;
|
|
} else {
|
|
echo "Got response: " . $queue->recv(ZMQ::MODE_NOBLOCK) . "\n";
|
|
break;
|
|
}
|
|
} catch (ZMQSocketException $e) {
|
|
/* EAGAIN means that the operation would have blocked, retry */
|
|
if ($e->getCode() === ZMQ::ERR_EAGAIN) {
|
|
echo " - Got EAGAIN, retrying ($retries)\n";
|
|
} else {
|
|
die(" - Error: " . $e->getMessage());
|
|
}
|
|
}
|
|
/* Sleep a bit between operations */
|
|
usleep(5);
|
|
} while (--$retries);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Sending message
|
|
- Unable to execute operation, retrying (4)
|
|
Got response: This is a message
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the message. Throws ZMQSocketException in error.
|
|
If <constant>ZMQ::MODE_NOBLOCK</constant> is used and the operation would
|
|
block &boolean; false shall be returned.
|
|
</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
|
|
-->
|