<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Async: Async::Application Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceAsync.html">Async</a>::<a class="el" href="classAsync_1_1Application.html">Application</a>
</div>
</div>
<div class="contents">
<h1>Async::Application Class Reference</h1><!-- doxytag: class="Async::Application" -->
<p>The base class for asynchronous applications.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncApplication_8h_source.html">AsyncApplication.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::Application:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1Application.png" usemap="#Async::Application_map" alt=""/>
<map id="Async::Application_map" name="Async::Application_map">
<area href="classAsync_1_1CppApplication.html" alt="Async::CppApplication" shape="rect" coords="0,56,140,80"/>
<area href="classAsync_1_1QtApplication.html" alt="Async::QtApplication" shape="rect" coords="150,56,290,80"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1Application-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1Application.html#a7d78bd044743245cce83c70a99d52eee">Application</a> (void)
<dl class="el"><dd class="mdescRight">Default constructor. <a href="#a7d78bd044743245cce83c70a99d52eee"></a><br/></dl><li>virtual <a class="el" href="classAsync_1_1Application.html#a6da18b828b3878a08df8d60b73c8e62f">~Application</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a6da18b828b3878a08df8d60b73c8e62f"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1Application.html#a860cbc9a94794b734642743a2ce15843">exec</a> (void)=0
<dl class="el"><dd class="mdescRight">Execute the application main loop. <a href="#a860cbc9a94794b734642743a2ce15843"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1Application.html#ac4b9e6a600d782f750992d86fee5cea3">quit</a> (void)=0
<dl class="el"><dd class="mdescRight">Exit the application main loop. <a href="#ac4b9e6a600d782f750992d86fee5cea3"></a><br/></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classAsync_1_1Application.html">Application</a> & <a class="el" href="classAsync_1_1Application.html#aa6d446d6b333e0a1e5cc1400c07aa898">app</a> (void)
<dl class="el"><dd class="mdescRight">Get the one and only application instance. <a href="#aa6d446d6b333e0a1e5cc1400c07aa898"></a><br/></dl></ul>
<h2>Friends</h2>
<ul>
<li>class <a class="el" href="classAsync_1_1Application.html#ab12f590b710df706233519ac3b6ccee5">FdWatch</a>
<li>class <a class="el" href="classAsync_1_1Application.html#a50de43af5bed41f30c071d8cce0e81bc">Timer</a>
<li>class <a class="el" href="classAsync_1_1Application.html#ab43c7fca52f20d814c95bed4c5ba05c0">DnsLookup</a>
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The base class for asynchronous applications. </p>
<p>This is the base class for all asynchronous applications. It is an abstract class and so it must be inherited from to create a class that can be instantiated. </p>
<p>Definition at line <a class="el" href="AsyncApplication_8h_source.html#l00118">118</a> of file <a class="el" href="AsyncApplication_8h_source.html">AsyncApplication.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7d78bd044743245cce83c70a99d52eee"></a><!-- doxytag: member="Async::Application::Application" ref="a7d78bd044743245cce83c70a99d52eee" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::Application::Application </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="a6da18b828b3878a08df8d60b73c8e62f"></a><!-- doxytag: member="Async::Application::~Application" ref="a6da18b828b3878a08df8d60b73c8e62f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Async::Application::~Application </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa6d446d6b333e0a1e5cc1400c07aa898"></a><!-- doxytag: member="Async::Application::app" ref="aa6d446d6b333e0a1e5cc1400c07aa898" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classAsync_1_1Application.html">Application</a>& Async::Application::app </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the one and only application instance. </p>
<p>Use this static member function to get the one and only instance of the application object. If an application object has not been previously created, the application will crash with a failed assertion. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a reference to the applicaton instance </dd></dl>
</div>
</div>
<a class="anchor" id="a860cbc9a94794b734642743a2ce15843"></a><!-- doxytag: member="Async::Application::exec" ref="a860cbc9a94794b734642743a2ce15843" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::Application::exec </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute the application main loop. </p>
<p>When this member function is called the application core will enter the core main loop. It will not exit from this loop until the <a class="el" href="classAsync_1_1Application.html#ac4b9e6a600d782f750992d86fee5cea3" title="Exit the application main loop.">Async::Application::quit</a> method is called. </p>
<p>Implemented in <a class="el" href="classAsync_1_1CppApplication.html#a9a921d33644bbb18767fb4d599f53bf4">Async::CppApplication</a>, and <a class="el" href="classAsync_1_1QtApplication.html#a9c126053824af95e9cbd0860028b5806">Async::QtApplication</a>.</p>
</div>
</div>
<a class="anchor" id="ac4b9e6a600d782f750992d86fee5cea3"></a><!-- doxytag: member="Async::Application::quit" ref="ac4b9e6a600d782f750992d86fee5cea3" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::Application::quit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Exit the application main loop. </p>
<p>This function should be called to exit the application core main loop. </p>
<p>Implemented in <a class="el" href="classAsync_1_1CppApplication.html#a092e40f449fa3423a66d4515941d8cb3">Async::CppApplication</a>, and <a class="el" href="classAsync_1_1QtApplication.html#a9fce02c06390d7bd6c4594bd3407c680">Async::QtApplication</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ab43c7fca52f20d814c95bed4c5ba05c0"></a><!-- doxytag: member="Async::Application::DnsLookup" ref="ab43c7fca52f20d814c95bed4c5ba05c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classAsync_1_1DnsLookup.html">DnsLookup</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="AsyncApplication_8h_source.html#l00162">162</a> of file <a class="el" href="AsyncApplication_8h_source.html">AsyncApplication.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab12f590b710df706233519ac3b6ccee5"></a><!-- doxytag: member="Async::Application::FdWatch" ref="ab12f590b710df706233519ac3b6ccee5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classAsync_1_1FdWatch.html">FdWatch</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="AsyncApplication_8h_source.html#l00160">160</a> of file <a class="el" href="AsyncApplication_8h_source.html">AsyncApplication.h</a>.</p>
</div>
</div>
<a class="anchor" id="a50de43af5bed41f30c071d8cce0e81bc"></a><!-- doxytag: member="Async::Application::Timer" ref="a50de43af5bed41f30c071d8cce0e81bc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classAsync_1_1Timer.html">Timer</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="AsyncApplication_8h_source.html#l00161">161</a> of file <a class="el" href="AsyncApplication_8h_source.html">AsyncApplication.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncApplication_8h_source.html">AsyncApplication.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
os
>
by-pkgid
>
9c481c872fb0ae0cbadccdc2f4a18ab6
>
files
>
133
