setstatuscallback.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setstatuscallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>GearmanClient::setStatusCallback</refname>
  <refpurpose>Set a callback for collecting task status</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="GearmanClient">
   <modifier>public</modifier> <type>bool</type><methodname>GearmanClient::setStatusCallback</methodname>
   <methodparam><type>callable</type><parameter>function</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets a callback function used for getting updated status information from a worker.  The function
   should accept a single argument, a <classname>GearmanTask</classname> object.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>function</parameter></term>
     <listitem>
      <para>
       A function to call
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>GearmanClient::setDataCallback</methodname></member>
    <member><methodname>GearmanClient::setCompleteCallback</methodname></member>
    <member><methodname>GearmanClient::setCreatedCallback</methodname></member>
    <member><methodname>GearmanClient::setExceptionCallback</methodname></member>
    <member><methodname>GearmanClient::setFailCallback</methodname></member>
    <member><methodname>GearmanClient::setWarningCallback</methodname></member>
    <member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
   </simplelist>
  </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:"~/.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
-->