php-doc-en/reference/tokyo_tyrant/tokyotyrant.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.tokyotyrant" 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 TokyoTyrant class</title>
 <titleabbrev>TokyoTyrant</titleabbrev>

 <partintro>

<!-- {{{ tokyotyrant intro -->
  <section xml:id="tokyotyrant.intro">
   &reftitle.intro;
   <para>
    The main Tokyo Tyrant class
   </para>
  </section>
<!-- }}} -->

  <section xml:id="tokyotyrant.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>TokyoTyrant</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>TokyoTyrant</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbdef-port">TokyoTyrant::RDBDEF_PORT</varname>
     <initializer>1978</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-streq">TokyoTyrant::RDBQC_STREQ</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-strinc">TokyoTyrant::RDBQC_STRINC</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-strbw">TokyoTyrant::RDBQC_STRBW</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-strew">TokyoTyrant::RDBQC_STREW</varname>
     <initializer>3</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-strand">TokyoTyrant::RDBQC_STRAND</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-stror">TokyoTyrant::RDBQC_STROR</varname>
     <initializer>5</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-stroreq">TokyoTyrant::RDBQC_STROREQ</varname>
     <initializer>6</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-strrx">TokyoTyrant::RDBQC_STRRX</varname>
     <initializer>7</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-numeq">TokyoTyrant::RDBQC_NUMEQ</varname>
     <initializer>8</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-numgt">TokyoTyrant::RDBQC_NUMGT</varname>
     <initializer>9</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-numge">TokyoTyrant::RDBQC_NUMGE</varname>
     <initializer>10</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-numlt">TokyoTyrant::RDBQC_NUMLT</varname>
     <initializer>11</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-numle">TokyoTyrant::RDBQC_NUMLE</varname>
     <initializer>12</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-numbt">TokyoTyrant::RDBQC_NUMBT</varname>
     <initializer>13</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-numoreq">TokyoTyrant::RDBQC_NUMOREQ</varname>
     <initializer>14</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-negate">TokyoTyrant::RDBQC_NEGATE</varname>
     <initializer>16777216</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqc-noidx">TokyoTyrant::RDBQC_NOIDX</varname>
     <initializer>33554432</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqo-strasc">TokyoTyrant::RDBQO_STRASC</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqo-strdesc">TokyoTyrant::RDBQO_STRDESC</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqo-numasc">TokyoTyrant::RDBQO_NUMASC</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqo-numdesc">TokyoTyrant::RDBQO_NUMDESC</varname>
     <initializer>3</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbit-lexical">TokyoTyrant::RDBIT_LEXICAL</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbit-decimal">TokyoTyrant::RDBIT_DECIMAL</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbit-token">TokyoTyrant::RDBIT_TOKEN</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbit-qgram">TokyoTyrant::RDBIT_QGRAM</varname>
     <initializer>3</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbit-opt">TokyoTyrant::RDBIT_OPT</varname>
     <initializer>9998</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbit-void">TokyoTyrant::RDBIT_VOID</varname>
     <initializer>9999</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbit-keep">TokyoTyrant::RDBIT_KEEP</varname>
     <initializer>16777216</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqcfts-ph">TokyoTyrant::RDBQCFTS_PH</varname>
     <initializer>15</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqcfts-and">TokyoTyrant::RDBQCFTS_AND</varname>
     <initializer>16</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqcfts-or">TokyoTyrant::RDBQCFTS_OR</varname>
     <initializer>17</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbqcfts-ex">TokyoTyrant::RDBQCFTS_EX</varname>
     <initializer>18</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbxolck-rec">TokyoTyrant::RDBXO_LCKREC</varname>
     <initializer>1</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbxolck-glb">TokyoTyrant::RDBXOLCK_GLB</varname>
     <initializer>2</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbrec-int">TokyoTyrant::RDBREC_INT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbrec-dbl">TokyoTyrant::RDBREC_DBL</varname>
     <initializer>2</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbms-union">TokyoTyrant::RDBMS_UNION</varname>
     <initializer>0</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbms-isect">TokyoTyrant::RDBMS_ISECT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>

    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="tokyotyrant.constants.rdbms-diff">TokyoTyrant::RDBMS_DIFF</varname>
     <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>
<!-- }}} -->

  </section>
  
<!-- {{{ tokyotyrant constants -->
  <section xml:id="tokyotyrant.constants">
   &reftitle.constants;
   <section xml:id="tokyotyrant.constants.types">
    <title>TokyoTyrant Constants</title>
    <variablelist>

     <varlistentry xml:id="tokyotyrant.constants.rdbdef-port">
      <term><constant>TokyoTyrant::RDBDEF_PORT</constant></term>
      <listitem>
       <para>The default port of the Tokyo Tyrant database</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-streq">
      <term><constant>TokyoTyrant::RDBQC_STREQ</constant></term>
      <listitem>
       <para>string is equal to</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-strinc">
      <term><constant>TokyoTyrant::RDBQC_STRINC</constant></term>
      <listitem>
       <para>string is included in</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-strbw">
      <term><constant>TokyoTyrant::RDBQC_STRBW</constant></term>
      <listitem>
       <para>string begins with</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-strew">
      <term><constant>TokyoTyrant::RDBQC_STREW</constant></term>
      <listitem>
       <para>string ends with</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-strand">
      <term><constant>TokyoTyrant::RDBQC_STRAND</constant></term>
      <listitem>
       <para>string includes all tokens in</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-stror">
      <term><constant>TokyoTyrant::RDBQC_STROR</constant></term>
      <listitem>
       <para>string includes at least one token in</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-stroreq">
      <term><constant>TokyoTyrant::RDBQC_STROREQ</constant></term>
      <listitem>
       <para>string is equal to at least one token in</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-strrx">
      <term><constant>TokyoTyrant::RDBQC_STRRX</constant></term>
      <listitem>
       <para>string matches regular expressions of</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-numeq">
      <term><constant>TokyoTyrant::RDBQC_NUMEQ</constant></term>
      <listitem>
       <para>number is equal to</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-numgt">
      <term><constant>TokyoTyrant::RDBQC_NUMGT</constant></term>
      <listitem>
       <para>number is greater than</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-numge">
      <term><constant>TokyoTyrant::RDBQC_NUMGE</constant></term>
      <listitem>
       <para>number is greater than or equal to</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-numlt">
      <term><constant>TokyoTyrant::RDBQC_NUMLT</constant></term>
      <listitem>
       <para>number is less than</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-numle">
      <term><constant>TokyoTyrant::RDBQC_NUMLE</constant></term>
      <listitem>
       <para>number is less than or equal to</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-numbt">
      <term><constant>TokyoTyrant::RDBQC_NUMBT</constant></term>
      <listitem>
       <para>number is between two tokens of</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-numoreq">
      <term><constant>TokyoTyrant::RDBQC_NUMOREQ</constant></term>
      <listitem>
       <para>number is equal to at least one token in</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-negate">
      <term><constant>TokyoTyrant::RDBQC_NEGATE</constant></term>
      <listitem>
       <para>negation flag</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqc-noidx">
      <term><constant>TokyoTyrant::RDBQC_NOIDX</constant></term>
      <listitem>
       <para>no index flag</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqo-strasc">
      <term><constant>TokyoTyrant::RDBQO_STRASC</constant></term>
      <listitem>
       <para>string ascending</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqo-strdesc">
      <term><constant>TokyoTyrant::RDBQO_STRDESC</constant></term>
      <listitem>
       <para>string descending</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqo-numasc">
      <term><constant>TokyoTyrant::RDBQO_NUMASC</constant></term>
      <listitem>
       <para>number ascending</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqo-numdesc">
      <term><constant>TokyoTyrant::RDBQO_NUMDESC</constant></term>
      <listitem>
       <para>number descending</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbit-lexical">
      <term><constant>TokyoTyrant::RDBIT_LEXICAL</constant></term>
      <listitem>
       <para>lexical string</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbit-decimal">
      <term><constant>TokyoTyrant::RDBIT_DECIMAL</constant></term>
      <listitem>
       <para>decimal string</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbit-token">
      <term><constant>TokyoTyrant::RDBIT_TOKEN</constant></term>
      <listitem>
       <para>token inverted index (Tokyo Tyrant &gt;= 1.1.29)</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbit-qgram">
      <term><constant>TokyoTyrant::RDBIT_QGRAM</constant></term>
      <listitem>
       <para>QGRAM inverted index (Tokyo Tyrant &gt;= 1.1.29)</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbit-opt">
      <term><constant>TokyoTyrant::RDBIT_OPT</constant></term>
      <listitem>
       <para>optimize</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbit-void">
      <term><constant>TokyoTyrant::RDBIT_VOID</constant></term>
      <listitem>
       <para>void</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbit-keep">
      <term><constant>TokyoTyrant::RDBIT_KEEP</constant></term>
      <listitem>
       <para>keep existing index</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqcfts-ph">
      <term><constant>TokyoTyrant::RDBQCFTS_PH</constant></term>
      <listitem>
       <para>full-text search with the phrase of (Tokyo Tyrant &gt;= 1.1.29)</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqcfts-and">
      <term><constant>TokyoTyrant::RDBQCFTS_AND</constant></term>
      <listitem>
       <para>full-text search with all tokens in (Tokyo Tyrant &gt;= 1.1.29)</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqcfts-or">
      <term><constant>TokyoTyrant::RDBQCFTS_OR</constant></term>
      <listitem>
       <para>full-text search with at least one token in (Tokyo Tyrant &gt;= 1.1.29)</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbqcfts-ex">
      <term><constant>TokyoTyrant::RDBQCFTS_EX</constant></term>
      <listitem>
       <para>full-text search with the compound expression of (Tokyo Tyrant &gt;= 1.1.29)</para>
      </listitem>
     </varlistentry>

    <varlistentry xml:id="tokyotyrant.constants.rdbms-union">
     <term><constant>TokyoTyrant::RDBQCFTS_AND</constant></term>
     <listitem>
      <para>Metasearch union between records (Tokyo Tyrant &gt;= 1.1.33)</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="tokyotyrant.constants.rdbms-isect">
     <term><constant>TokyoTyrant::RDBQCFTS_OR</constant></term>
     <listitem>
      <para>Metasearch intersection between records (Tokyo Tyrant &gt;= 1.1.33)</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="tokyotyrant.constants.rdbms-diff">
     <term><constant>TokyoTyrant::RDBQCFTS_EX</constant></term>
     <listitem>
      <para>Metasearch difference between records (Tokyo Tyrant &gt;= 1.1.33)</para>
     </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>
       <para>record locking</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbxolck-glb">
      <term><constant>TokyoTyrant::RDBXOLCK_GLB</constant></term>
      <listitem>
       <para>global locking</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbrec-int">
      <term><constant>TokyoTyrant::RDBREC_INT</constant></term>
      <listitem>
       <para>record type int</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.rdbrec-dbl">
      <term><constant>TokyoTyrant::RDBREC_DBL</constant></term>
      <listitem>
       <para>record type float (double)</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-success">
      <term><constant>TokyoTyrant::TTE_SUCCESS</constant></term>
      <listitem>
       <para>success</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-invalid">
      <term><constant>TokyoTyrant::TTE_INVALID</constant></term>
      <listitem>
       <para>invalid operation</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-nohost">
      <term><constant>TokyoTyrant::TTE_NOHOST</constant></term>
      <listitem>
       <para>host not found</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-refused">
      <term><constant>TokyoTyrant::TTE_REFUSED</constant></term>
      <listitem>
       <para>connection refused</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-send">
      <term><constant>TokyoTyrant::TTE_SEND</constant></term>
      <listitem>
       <para>send error</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-recv">
      <term><constant>TokyoTyrant::TTE_RECV</constant></term>
      <listitem>
       <para>recv error</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-keep">
      <term><constant>TokyoTyrant::TTE_KEEP</constant></term>
      <listitem>
       <para>record exist</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-norec">
      <term><constant>TokyoTyrant::TTE_NOREC</constant></term>
      <listitem>
       <para>no record found</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="tokyotyrant.constants.tte-misc">
      <term><constant>TokyoTyrant::TTE_MISC</constant></term>
      <listitem>
       <para>miscellaneous error</para>
      </listitem>
     </varlistentry>

    </variablelist>
   </section>
  </section>
<!-- }}} -->


 </partintro>

 &reference.tokyo-tyrant.entities.tokyotyrant;

</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
-->