mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
d530899344
* Fix reference/zmq having returnvalues in wrong order * Add missing parameters sections to reference/zmq * Fix errors being in returnvalues * Fix typo `zmqpoll/poll.xml` * Remove useless noise * Add classname tag for auto linking * Move callback signature to parameters * Remove ZMQContext contructor return value * Fix ZMQContext::getSocket return value * Fix ZMQSocket::recv return value * Fix ZMQSocket::recv errors section Co-authored-by: George Peter Banyard <girgias@php.net> Closes GH-566.
122 lines
3 KiB
XML
122 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="zmqsocket.connect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ZMQSocket::connect</refname>
|
|
<refpurpose>Connect the socket</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>ZMQSocket</type><methodname>ZMQSocket::connect</methodname>
|
|
<methodparam><type>string</type><parameter>dsn</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>force</parameter><initializer>&false;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Connect the socket to a remote endpoint. The endpoint is defined in format <literal>transport://address</literal> where
|
|
transport is one of the following: inproc, ipc, tcp, pgm or epgm.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>dsn</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The connect dsn, for example <literal>transport://address</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>force</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Tries to connect even if the socket has already been connected to given endpoint.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the current object.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws <classname>ZMQSocketException</classname> on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>ZMQContext</function> example</title>
|
|
<para>
|
|
Construct a new context and allocate request socket from it
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* Server hostname */
|
|
$dsn = "tcp://127.0.0.1:5555";
|
|
|
|
/* Create a socket */
|
|
$socket = new ZMQSocket(new ZMQContext(), ZMQ::SOCKET_REQ, 'my socket');
|
|
|
|
/* Get list of connected endpoints */
|
|
$endpoints = $socket->getEndpoints();
|
|
|
|
/* Check if the socket is connected */
|
|
if (!in_array($dsn, $endpoints['connect'])) {
|
|
echo "<p>Connecting to $dsn</p>";
|
|
$socket->connect($dsn);
|
|
} else {
|
|
echo "<p>Already connected to $dsn</p>";
|
|
}
|
|
|
|
/* Send and receive */
|
|
$socket->send("Hello!");
|
|
$message = $socket->recv();
|
|
|
|
echo "<p>Server said: {$message}</p>";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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
|
|
-->
|