php-doc-en/reference/sam/SAMConnection/subscribe.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='samconnection.subscribe' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SAMConnection::subscribe</refname>
  <refpurpose>
   Create a subscription to a specified topic
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>SAMConnection::subscribe</methodname>
   <methodparam><type>string</type><parameter>targetTopic</parameter></methodparam>
  </methodsynopsis>
  <para>
   The "subscribe" method is used to create a new subscription to a specified topic.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>targetTopic</parameter></term>
     <listitem>
      <para>
       The identity of the topic (topic://topicname) to subscribe to.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A subscription identifier that can be used in a subsequent receive call as
   a selector to obtain any topic data or &false; if an error occurred. The
   subscription identifier should be used in the receive call in place of the
   simple topic name.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Subscribe to a topic</title>
    <programlisting role="php">
<![CDATA[
<?php
$subid = $conn->subscribe('topic://A');
if (!$subid) {
  // The subscribe failed!
  echo "Subscribe failed ($conn->errno) $conn->error";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="samconnection.unsubscribe" /></member>
   </simplelist>
  </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
-->