php-doc-en/reference/mysqli/functions/mysqli-thread-id.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
  <refentry id="function.mysqli-thread-id">
   <refnamediv>
    <refname>mysqli_thread_id</refname>
    <refname>mysqli->thread_id</refname>
    <refpurpose>Returns the thread ID for the current connection</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style:</para>
    <methodsynopsis>
     <type>int</type><methodname>mysqli_thread_id</methodname>
     <methodparam><type>object</type><parameter>link</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (property):</para>
    <classsynopsis>
     <ooclass><classname>mysqli</classname></ooclass>
     <fieldsynopsis><type>int</type><varname>thread_id</varname></fieldsynopsis>
    </classsynopsis>
    <para>
     The <function>mysqli_thread_id</function> function returns the thread
     ID for the current connection which can then be killed using the
     <function>mysqli_kill</function> function. If the connection is lost
     and you reconnect with <function>mysqli_ping</function>, the thread ID
     will be other. Therefore you should get the thread ID only when you need it.
    </para>
    <note>
     <para>
      The thread ID is assigned on a connection-by-connection basis. Hence,
      if the connection is broken and then re-established a new thread ID
      will be assigned.
     </para>
     <para>
      To kill a running query you can use the SQL command <literal>KILL QUERY processid</literal>.
     </para>
    </note>
   </refsect1>
   <refsect1>
    <title>Return values</title>
    <para>
     <function>mysqli_thread_id</function> returns the Thread ID for the current connection.
    </para> 
   </refsect1>
   <refsect1>
    <title>See also</title>
    <para>
     <function>mysqli_kill</function>
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* determine our thread id */
$thread_id = $mysqli->thread_id;

/* Kill connection */
$mysqli->kill($thread_id);

/* This should produce an error */
if (!$mysqli->query("CREATE TABLE myCity LIKE City")) {
    printf("Error: %s\n", $mysqli->error);
    exit;
}

/* close connection */
$mysqli->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* determine our thread id */
$thread_id = mysqli_thread_id($link);

/* Kill connection */
mysqli_kill($link, $thread_id);

/* This should produce an error */
if (!mysqli_query($link, "CREATE TABLE myCity LIKE City")) {
    printf("Error: %s\n", mysqli_error($link));
    exit;
}

/* close connection */
mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    <para>
     The above examples would produce the following output:
    </para>
    <screen>
<![CDATA[
Error: MySQL server has gone away
]]>
    </screen>
   </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
-->