From a2a5b3f4b3fa288fe6ff74b6d7ed18df62c1831c Mon Sep 17 00:00:00 2001
From: Mikko Koppanen <mkoppanen@php.net>
Date: Fri, 4 Sep 2009 08:03:59 +0000
Subject: [PATCH] docs for tune method

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288035 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/tokyo_tyrant/tokyotyrant.xml        | 15 ++++
 .../tokyo_tyrant/tokyotyrant/connecturi.xml   |  2 +-
 reference/tokyo_tyrant/tokyotyrant/sync.xml   |  2 +-
 reference/tokyo_tyrant/tokyotyrant/tune.xml   | 75 +++++++++++++++++++
 4 files changed, 92 insertions(+), 2 deletions(-)
 create mode 100644 reference/tokyo_tyrant/tokyotyrant/tune.xml

diff --git a/reference/tokyo_tyrant/tokyotyrant.xml b/reference/tokyo_tyrant/tokyotyrant.xml
index 4c219e9dfd..661a82c11d 100644
--- a/reference/tokyo_tyrant/tokyotyrant.xml
+++ b/reference/tokyo_tyrant/tokyotyrant.xml
@@ -272,6 +272,13 @@
      <initializer>2</initializer>
     </fieldsynopsis>
     
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="tokyotyrant.constants.RDBT_RECON">TokyoTyrant::RDBT_RECON</varname>
+     <initializer>1</initializer>
+    </fieldsynopsis>
+
     <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.tokyotyrant')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
    </classsynopsis>
@@ -524,6 +531,14 @@
      </listitem>
     </varlistentry>
 
+    <varlistentry xml:id="tokyotyrant.constants.RDBT_RECON">
+     <term><constant>TokyoTyrant::RDBT_RECON</constant></term>
+     <listitem>
+      <para>Whether to reconnect on connection failure. 
+            It is recommended to have this parameter on for persistent connections</para>
+     </listitem>
+    </varlistentry>
+
      <varlistentry xml:id="tokyotyrant.constants.RDBXOLCK_REC">
       <term><constant>TokyoTyrant::RDBXOLCK_REC</constant></term>
       <listitem>
diff --git a/reference/tokyo_tyrant/tokyotyrant/connecturi.xml b/reference/tokyo_tyrant/tokyotyrant/connecturi.xml
index 80d2bdec80..0f7d6e8928 100644
--- a/reference/tokyo_tyrant/tokyotyrant/connecturi.xml
+++ b/reference/tokyo_tyrant/tokyotyrant/connecturi.xml
@@ -62,7 +62,7 @@ $tt->connectUri("tcp://localhost:1978/")->put("test", "hi");
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>TokyoTyrant::connect</methodname></member>
    </simplelist>
   </para>
  </refsect1>
diff --git a/reference/tokyo_tyrant/tokyotyrant/sync.xml b/reference/tokyo_tyrant/tokyotyrant/sync.xml
index bbf00582d8..47ddf90650 100644
--- a/reference/tokyo_tyrant/tokyotyrant/sync.xml
+++ b/reference/tokyo_tyrant/tokyotyrant/sync.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>tokyotyrant::sync</methodname>
+   <modifier>public</modifier> <type>void</type><methodname>TokyoTyrant::sync</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/tokyo_tyrant/tokyotyrant/tune.xml b/reference/tokyo_tyrant/tokyotyrant/tune.xml
new file mode 100644
index 0000000000..9d428883f1
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrant/tune.xml
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 287587 $ -->
+
+<refentry xml:id="tokyotyrant.putnr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrant::tune</refname>
+  <refpurpose>Tunes connection values</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>TokyoTyrant</type><methodname>TokyoTyrant::tune</methodname>
+   <methodparam><type>float</type><parameter>timeout</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Tunes database connection options. 
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>timeout</parameter></term>
+     <listitem>
+      <para>
+       The objects timeout value (default: 5.0)
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>options</parameter></term>
+     <listitem>
+      <para>
+       Bitmask of options to tune. This can be either 0 or <constant>TokyoTyrant::RDBT_RECON</constant>. 
+       It is recommended not to change the second parameter.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+    This method returns a reference to the current object and throws TokyoTyrantException on failure.
+  </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:"../../../../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
+-->