Permalink
Browse files

Initial commit of AMQP documentation after preliminary approval from …

…PHP Doc list.

Part 1 of 2 part commit. Associated commit is of doc-base.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk/reference/amqp@300253 c90b9560-bf6c-de11-be94-00142212c4b1
  • Loading branch information...
0 parents commit fca1df92507110b43ac3e4d3c278583f46a29cf2 pdezwart committed Jun 7, 2010
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.amqpconnection" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The AMQPConnection class</title>
+ <titleabbrev>AMQPConnection</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ AMQPConnection intro -->
+ <section xml:id="amqpconnection.intro">
+ &reftitle.intro;
+ <para>
+ Represents a connection to an AMQP broker.
+ </para>
+ </section>
+<!-- }}} -->
+
+ <section xml:id="amqpconnection.synopsis">
+ &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+ <classsynopsis>
+ <ooclass><classname>AMQPConnection</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+ <classsynopsisinfo>
+ <ooclass>
+ <classname>AMQPConnection</classname>
+ </ooclass>
+ </classsynopsisinfo>
+<!-- }}} -->
+
+ <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpconnection')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ </classsynopsis>
+<!-- }}} -->
+
+ </section>
+
+ </partintro>
+
+ &reference.amqp.entities.amqpconnection;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="amqpconnection.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>AMQPConnection::__construct</refname>
+ <refpurpose>Create an instance of AMQPConnection</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <methodname>AMQPConnection::__construct</methodname>
+ <methodparam choice="opt"><type>array</type><parameter>credentials</parameter><initializer>array()</initializer></methodparam>
+ </methodsynopsis>
+ <para>
+ Creates an <classname>AMQPConnection</classname> instance representing a connection to an AMQP broker.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>credentials</parameter></term>
+ <listitem>
+ <para>
+ The <parameter>credentials</parameter> is an optional array of credential information for connecting to the AMQP
+ broker. The keys used in the <parameter>credentials</parameter> array are: host, port, vhost, login and password.
+ All other keys will be ignored.
+ </para>
+ <para>
+ For each missing credential, the extension will check the ini settings or use the default value.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An AMQPConnection object.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>AMQPConnection::__construct</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+/* Create a connection using all default credentials: */
+$connection1 = new AMQPConnection();
+
+$connection2 = new AMQPConnection(array(
+ 'host' => 'example.host',
+ 'vhost' => '/',
+ 'port' => 5763,
+ 'login' => 'user',
+ 'password' => 'password'
+));
+
+?>
+]]>
+ </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
+-->
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="amqpconnection.isconnected" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>AMQPConnection::isConnected</refname>
+ <refpurpose>Determine if the AMQPConnection object is still connected to the broker.</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>void</type><methodname>AMQPConnection::isConnected</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ This method will check whether the connection to the AMQP broker is still valid. It does so by checking
+ the return status of the last command.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>AMQPConnection::isConnected</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+/* Create a new connection */
+$cnn = new AMQPConnection();
+
+/* Check that connection is working */
+if (!$cnn->isConnected()) {
+ die('The connection to the server was not established.');
+}
+
+?>
+]]>
+ </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
+-->
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.amqpconnectionexception" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The AMQPConnectionException class</title>
+ <titleabbrev>AMQPConnectionException</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ AMQPConnectionException intro -->
+ <section xml:id="amqpconnectionexception.intro">
+ &reftitle.intro;
+ <para>
+
+ </para>
+ </section>
+<!-- }}} -->
+
+ <section xml:id="amqpconnectionexception.synopsis">
+ &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+ <classsynopsis>
+ <ooclass><classname>AMQPConnectionException</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+ <classsynopsisinfo>
+ <ooclass>
+ <classname>AMQPConnectionException</classname>
+ </ooclass>
+
+ <ooclass>
+ <modifier>extends</modifier>
+ <classname>AMQPException</classname>
+ </ooclass>
+ </classsynopsisinfo>
+<!-- }}} -->
+ <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+
+
+ <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpconnectionexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+
+ <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+
+ </classsynopsis>
+<!-- }}} -->
+
+ </section>
+
+
+<!-- {{{ AMQPConnectionException properties -->
+ <section xml:id="amqpconnectionexception.props">
+ &reftitle.properties;
+ <variablelist>
+ <varlistentry xml:id="amqpconnectionexception.props.message">
+ <term><varname>message</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="amqpconnectionexception.props.code">
+ <term><varname>code</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="amqpconnectionexception.props.file">
+ <term><varname>file</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="amqpconnectionexception.props.line">
+ <term><varname>line</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+<!-- }}} -->
+
+
+ </partintro>
+
+ &reference.amqp.entities.amqpconnectionexception;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
Oops, something went wrong.

0 comments on commit fca1df9

Please sign in to comment.