From 2b934de8118cd43bbfbe73a6e9a95f0a6e7d00a2 Mon Sep 17 00:00:00 2001
From: Pieter de Zwart <pdezwart@php.net>
Date: Wed, 5 Dec 2012 04:31:42 +0000
Subject: [PATCH] Updating AMQP documentation * Replacing deprecated declare
 functions * Adding missing timeouts

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328670 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/amqp/amqpconnection/getport.xml     |  4 +-
 reference/amqp/amqpconnection/gettimeout.xml  | 56 +++++++++++
 reference/amqp/amqpconnection/settimeout.xml  | 98 +++++++++++++++++++
 .../{declare.xml => declareexchange.xml}      |  0
 .../{declare.xml => declarequeue.xml}         |  0
 5 files changed, 155 insertions(+), 3 deletions(-)
 create mode 100644 reference/amqp/amqpconnection/gettimeout.xml
 create mode 100644 reference/amqp/amqpconnection/settimeout.xml
 rename reference/amqp/amqpexchange/{declare.xml => declareexchange.xml} (100%)
 rename reference/amqp/amqpqueue/{declare.xml => declarequeue.xml} (100%)

diff --git a/reference/amqp/amqpconnection/getport.xml b/reference/amqp/amqpconnection/getport.xml
index 37965c8c1e..5eb767b756 100644
--- a/reference/amqp/amqpconnection/getport.xml
+++ b/reference/amqp/amqpconnection/getport.xml
@@ -14,11 +14,9 @@
    <void />
   </methodsynopsis>
   <para>
-
+    Return the port configured for this <classname>AMQPConnection</classname> object.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
diff --git a/reference/amqp/amqpconnection/gettimeout.xml b/reference/amqp/amqpconnection/gettimeout.xml
new file mode 100644
index 0000000000..fbcf69c52f
--- /dev/null
+++ b/reference/amqp/amqpconnection/gettimeout.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 323281 $ --> 
+
+<refentry xml:id="amqpconnection.gettimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>AMQPConnection::getTimeout</refname>
+  <refpurpose>Get the configured timeout</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>AMQPConnection::getTimeout</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+    Get the current timeout setting for this instance of an <classname>AMQPConnection</classname> object.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+    The configured timeout as an integer.
+  </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
+-->
diff --git a/reference/amqp/amqpconnection/settimeout.xml b/reference/amqp/amqpconnection/settimeout.xml
new file mode 100644
index 0000000000..a7e7735474
--- /dev/null
+++ b/reference/amqp/amqpconnection/settimeout.xml
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 317663 $ -->
+
+<refentry xml:id="amqpconnection.settimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>AMQPConnection::setTimeout</refname>
+  <refpurpose>Set the timeout.</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>AMQPConnection::setTimeout</methodname>
+   <methodparam><type>float</type><parameter>timeout</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Set the amount of time, in seconds, after which this instance of an <classname>AMQPConnection</classname> object times out a request to the broker. Setting this value will
+   override the default value specified by the <literal>amqp.timeout</literal> INI setting.
+   
+   To specify a timeout of 500ms, simply pass in 0.5.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>timeout</parameter></term>
+     <listitem>
+      <para>
+       The timeout used to connect to the AMQP broker.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws an <classname>AMQPConnectionException</classname> if <parameter>timeout</parameter> is longer less than 0.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><methodname>AMQPConnection::setTimeout</methodname> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+/* Create a new connection */
+$cnn = new AMQPConnection();
+
+// set the timeout
+$cnn->setTimeout(5672);
+
+?>
+]]>
+    </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
+-->
diff --git a/reference/amqp/amqpexchange/declare.xml b/reference/amqp/amqpexchange/declareexchange.xml
similarity index 100%
rename from reference/amqp/amqpexchange/declare.xml
rename to reference/amqp/amqpexchange/declareexchange.xml
diff --git a/reference/amqp/amqpqueue/declare.xml b/reference/amqp/amqpqueue/declarequeue.xml
similarity index 100%
rename from reference/amqp/amqpqueue/declare.xml
rename to reference/amqp/amqpqueue/declarequeue.xml