<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>incron: EventDispatcher Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>EventDispatcher Class Reference</h1><!-- doxytag: class="EventDispatcher" -->Event dispatcher class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="usertable_8h-source.html">usertable.h</a>></code>
<p>
<p>
<a href="classEventDispatcher-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#a85c268c8fa835ded477659ecd017ad4">EventDispatcher</a> (int iPipeFd, <a class="el" href="classInotify.html">Inotify</a> *pIn, <a class="el" href="classInotifyWatch.html">InotifyWatch</a> *pSys, <a class="el" href="classInotifyWatch.html">InotifyWatch</a> *pUser)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a85c268c8fa835ded477659ecd017ad4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#bb5f401014e87f03027d6c4450964e55">~EventDispatcher</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#bb5f401014e87f03027d6c4450964e55"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#c2b9520436761282001d8c5ea539482a">ProcessEvents</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Processes events. <a href="#c2b9520436761282001d8c5ea539482a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#35f9789ceaf15a9cbeeae65717c0a068">Register</a> (<a class="el" href="classUserTable.html">UserTable</a> *pTab)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Registers an user table. <a href="#35f9789ceaf15a9cbeeae65717c0a068"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#6bd699c73e11db92ffc737ece3c30715">Unregister</a> (<a class="el" href="classUserTable.html">UserTable</a> *pTab)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregisters an user table. <a href="#6bd699c73e11db92ffc737ece3c30715"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#438297748715864a0b7d974754ebdcb4">GetSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the poll data size. <a href="#438297748715864a0b7d974754ebdcb4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct pollfd * </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#1309b15de686e9bdbf8f1ff8a1285e79">GetPollData</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the poll data. <a href="#1309b15de686e9bdbf8f1ff8a1285e79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#4a847781965ff8539df8fab05720cb8f">Rebuild</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rebuilds the poll array data. <a href="#4a847781965ff8539df8fab05720cb8f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventDispatcher.html#b1c59d7635d5aedbe6cc2f4315c2d269">Clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes all registered user tables. <a href="#b1c59d7635d5aedbe6cc2f4315c2d269"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Event dispatcher class.
<p>
This class processes events and distributes them as needed. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a85c268c8fa835ded477659ecd017ad4"></a><!-- doxytag: member="EventDispatcher::EventDispatcher" ref="a85c268c8fa835ded477659ecd017ad4" args="(int iPipeFd, Inotify *pIn, InotifyWatch *pSys, InotifyWatch *pUser)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EventDispatcher::EventDispatcher </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iPipeFd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classInotify.html">Inotify</a> * </td>
<td class="paramname"> <em>pIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> * </td>
<td class="paramname"> <em>pSys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> * </td>
<td class="paramname"> <em>pUser</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>iPipeFd</em> </td><td>pipe descriptor </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pIn</em> </td><td>inotify object for table management </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pSys</em> </td><td>watch for system tables </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pUser</em> </td><td>watch for user tables </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="bb5f401014e87f03027d6c4450964e55"></a><!-- doxytag: member="EventDispatcher::~EventDispatcher" ref="bb5f401014e87f03027d6c4450964e55" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EventDispatcher::~EventDispatcher </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c2b9520436761282001d8c5ea539482a"></a><!-- doxytag: member="EventDispatcher::ProcessEvents" ref="c2b9520436761282001d8c5ea539482a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EventDispatcher::ProcessEvents </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Processes events.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pipe event occurred yes/no </dd></dl>
</div>
</div><p>
<a class="anchor" name="35f9789ceaf15a9cbeeae65717c0a068"></a><!-- doxytag: member="EventDispatcher::Register" ref="35f9789ceaf15a9cbeeae65717c0a068" args="(UserTable *pTab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EventDispatcher::Register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUserTable.html">UserTable</a> * </td>
<td class="paramname"> <em>pTab</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Registers an user table.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pTab</em> </td><td>user table </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6bd699c73e11db92ffc737ece3c30715"></a><!-- doxytag: member="EventDispatcher::Unregister" ref="6bd699c73e11db92ffc737ece3c30715" args="(UserTable *pTab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EventDispatcher::Unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUserTable.html">UserTable</a> * </td>
<td class="paramname"> <em>pTab</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unregisters an user table.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pTab</em> </td><td>user table </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="438297748715864a0b7d974754ebdcb4"></a><!-- doxytag: member="EventDispatcher::GetSize" ref="438297748715864a0b7d974754ebdcb4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t EventDispatcher::GetSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the poll data size.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>poll data size </dd></dl>
</div>
</div><p>
<a class="anchor" name="1309b15de686e9bdbf8f1ff8a1285e79"></a><!-- doxytag: member="EventDispatcher::GetPollData" ref="1309b15de686e9bdbf8f1ff8a1285e79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct pollfd* EventDispatcher::GetPollData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the poll data.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>poll data </dd></dl>
</div>
</div><p>
<a class="anchor" name="4a847781965ff8539df8fab05720cb8f"></a><!-- doxytag: member="EventDispatcher::Rebuild" ref="4a847781965ff8539df8fab05720cb8f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EventDispatcher::Rebuild </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rebuilds the poll array data.
<p>
</div>
</div><p>
<a class="anchor" name="b1c59d7635d5aedbe6cc2f4315c2d269"></a><!-- doxytag: member="EventDispatcher::Clear" ref="b1c59d7635d5aedbe6cc2f4315c2d269" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EventDispatcher::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes all registered user tables.
<p>
It doesn't cause poll data rebuilding.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="usertable_8h-source.html">usertable.h</a><li><a class="el" href="usertable_8cpp.html">usertable.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 21 22:27:24 2009 for incron by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
a964702347d726c5f8ba742f8b9d5908
>
files
>
26
