<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventconfig.setmaxdispatchinterval" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EventConfig::setMaxDispatchInterval</refname>
  <refpurpose>Prevents priority inversion</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier>
   <type>void</type>
   <methodname>EventConfig::setMaxDispatchInterval</methodname>
   <methodparam>
    <type>int</type>
    <parameter>max_interval</parameter>
   </methodparam>
   <methodparam>
    <type>int</type>
    <parameter>max_callbacks</parameter>
   </methodparam>
   <methodparam>
    <type>int</type>
    <parameter>min_priority</parameter>
   </methodparam>
  </methodsynopsis>
  <para>
   Prevents priority inversion by limiting how many low-priority event
   callbacks can be invoked before checking for more high-priority events.
  </para>
  <note>
   <para>
    Available since
    <literal>libevent 2.1.0-alpha</literal>
    .
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>max_interval</parameter>
    </term>
    <listitem>
     <para>
      An interval after which Libevent should stop running callbacks and check
      for more events, or
      <constant>0</constant>
      , if there should be no such interval.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>max_callbacks</parameter>
    </term>
    <listitem>
     <para>
      A number of callbacks after which Libevent should stop running callbacks
      and check for more events, or
      <constant>-1</constant>
      , if there should be no such limit.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>min_priority</parameter>
    </term>
    <listitem>
     <para>
      A priority below which
      <parameter>max_interval</parameter>
      and
      <parameter>max_callbacks</parameter>
      should not be enforced. If this is set to
      <constant>0</constant>
      , they are enforced for events of every priority; if it&apos;s set to
      <constant>1</constant>
      , they&apos;re enforced for events of priority
      <constant>1</constant>
      and above, and so on.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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
-->
