php-doc-en/reference/mongo/context/log-killcursor.xml
2014-04-22 02:02:53 +00:00

83 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 299488 $ -->
<refentry xml:id="function.log-killcursor" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>log_killcursor</refname>
<refpurpose>Callback When Executing KILLCURSOR operations</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<methodname>log_killcursor</methodname>
<methodparam><type>array</type><parameter>server</parameter></methodparam>
<methodparam><type>array</type><parameter>info</parameter></methodparam>
</methodsynopsis>
<para>
A <type>callable</type> function, used by the
<link linkend="context.mongodb.log-killcursor">log_killcursor context option</link>,
when reading a killcursor from MongoDB.
</para>
<note>
<para>
This is <emphasis>not</emphasis> a real function, only a prototype of how the function should
be.
</para>
</note>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
&mongo.context.server;
<varlistentry>
<term>
<parameter>info</parameter>
</term>
<listitem>
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>key</entry>
<entry>value</entry>
</row>
</thead>
<tbody>
<row>
<entry>cursor_id</entry>
<entry>integer, the cursor identifier to kill</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</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
-->