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

<refentry xml:id="seaslog.getrequestid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SeasLog::getRequestID</refname>
  <refpurpose>Get SeasLog request_id differentiated requests</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>SeasLog::getRequestID</methodname>
   <void />
  </methodsynopsis>
  <para>
    To distinguish a single request, such as not invoking the 
    <methodname>SeasLog::setRequestId</methodname> function，
    the unique value generated by the built-in `static char *get_uniqid ()` 
    function is used when the request is initialized.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Return string generated by the built-in `static char *get_uniqid ()` function,
   or setted by <methodname>SeasLog::setRequestId</methodname> function.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>SeasLog::getRequestID</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php

var_dump(SeasLog::getRequestID());
var_dump(SeasLog::setRequestID('reqeust_id_test_'.time()));
var_dump(SeasLog::getRequestID());

?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
string(13) "5b3f21a209519"
bool(true)
string(26) "reqeust_id_test_1530864034"
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SeasLog::setRequestID</methodname></member>
   <member>The Variable `%Q` in 
   <link linkend="ini.seaslog.default-template">Seaslog Default Variable Table</link>.</member>
  </simplelist>
 </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
-->
