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

<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evloop.run">

<refnamediv>

<refname>EvLoop::run</refname>

<refpurpose>Begin checking for events and calling callbacks for the loop</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<modifier>public</modifier>

<type>void</type>

<methodname>EvLoop::run</methodname>

<methodparam choice="opt">

<type>int</type>

<parameter>flags</parameter>

<initializer>0</initializer>

</methodparam>

</methodsynopsis>

<simpara>

Begin checking for events and calling callbacks for the current event loop.

Returns when a callback calls

<methodname>Ev::stop</methodname>

method, or the flags are nonzero(in which case the return value is true) or

when there are no active watchers which reference the loop(

<methodname>EvWatcher::keepalive</methodname>

is &true;), in which case the return value will be &false;. The return

value can generally be interpreted as

<emphasis>if &true;, there is more work left

to do</emphasis>.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term>

<parameter>flags</parameter>

</term>

<listitem>

<para>

Optional parameter

<parameter>flags</parameter>

can be one of the following:

<table>

<title>

List for possible values of <parameter>flags</parameter>

</title>

<tgroup cols="2">

<thead>

<row>

<entry>

<parameter>flags</parameter>

</entry>

<entry>Description</entry>

</row>

</thead>

<tbody>

<row>

<entry>

<literal>0</literal>

</entry>

<entry>The default behavior described above</entry>

</row>

<row>

<entry>

<constant>Ev::RUN_ONCE</constant>

</entry>

<entry>Block at most one(wait, but don't loop)</entry>

</row>

<row>

<entry>

<constant>Ev::RUN_NOWAIT</constant>

</entry>

<entry>Don't block at all(fetch/handle events, but don't wait)</entry>

</row>

</tbody>

</tgroup>

</table>

</para>

<simpara>

See

<link linkend="ev.constants.run-flags">the run flag

constants</link>.

</simpara>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

&return.void;

</simpara>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member>

<methodname>EvLoop::stop</methodname>

</member>

<member>

<methodname>Ev::run</methodname>

</member>

</simplelist>

</refsect1>

</refentry>