<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: iJobQueue Struct Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <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> <h1>iJobQueue Struct Reference</h1><!-- doxytag: class="iJobQueue" --><!-- doxytag: inherits="iBase" -->Interface to simple job management. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="job_8h-source.html">iutil/job.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for iJobQueue:</div> <div class="dynsection"> <p><center><img src="structiJobQueue__inherit__graph.png" border="0" usemap="#iJobQueue__inherit__map" alt="Inheritance graph"></center> <map name="iJobQueue__inherit__map"> <area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< CS::Threading::ThreadedJobQueue, iJobQueue \>" alt="" coords="5,161,480,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="215,7,271,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="structiJobQueue-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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiJobQueue.html#1e237d32f35b7a637f8185a731ae58fb">Enqueue</a> (<a class="el" href="structiJob.html">iJob</a> *job)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a job to the queue. <a href="#1e237d32f35b7a637f8185a731ae58fb"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiJobQueue.html#f6fbf1ed078443691c8e8f9a0e2d3f21">PullAndRun</a> (<a class="el" href="structiJob.html">iJob</a> *job)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a job is still in the queue. <a href="#f6fbf1ed078443691c8e8f9a0e2d3f21"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiJobQueue.html#5c6bfc504785f4abfa067333f5efaf46">Unqueue</a> (<a class="el" href="structiJob.html">iJob</a> *job, bool waitIfCurrent=true)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a job from the queue. <a href="#5c6bfc504785f4abfa067333f5efaf46"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Interface to simple job management. <p> Jobs are enqueued and run one after another, e.g. in another thread. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="threadjobqueue_8h.html#7fef81ebc0c8a7ea66f230fdb303be0e">csThreadJobQueue</a> </dd></dl> <p>Definition at line <a class="el" href="job_8h-source.html#l00047">47</a> of file <a class="el" href="job_8h-source.html">job.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="1e237d32f35b7a637f8185a731ae58fb"></a><!-- doxytag: member="iJobQueue::Enqueue" ref="1e237d32f35b7a637f8185a731ae58fb" args="(iJob *job)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iJobQueue::Enqueue </td> <td>(</td> <td class="paramtype"><a class="el" href="structiJob.html">iJob</a> * </td> <td class="paramname"> <em>job</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add a job to the queue. <p> </div> </div><p> <a class="anchor" name="f6fbf1ed078443691c8e8f9a0e2d3f21"></a><!-- doxytag: member="iJobQueue::PullAndRun" ref="f6fbf1ed078443691c8e8f9a0e2d3f21" args="(iJob *job)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iJobQueue::PullAndRun </td> <td>(</td> <td class="paramtype"><a class="el" href="structiJob.html">iJob</a> * </td> <td class="paramname"> <em>job</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Check if a job is still in the queue. <p> If yes, remove it from the queue and run it immediately. </div> </div><p> <a class="anchor" name="5c6bfc504785f4abfa067333f5efaf46"></a><!-- doxytag: member="iJobQueue::Unqueue" ref="5c6bfc504785f4abfa067333f5efaf46" args="(iJob *job, bool waitIfCurrent=true)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iJobQueue::Unqueue </td> <td>(</td> <td class="paramtype"><a class="el" href="structiJob.html">iJob</a> * </td> <td class="paramname"> <em>job</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>waitIfCurrent</em> = <code>true</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Remove a job from the queue. <p> If the job is currently running and <em>waitIfCurrent</em> is true, wait until the job has finished. This guarantees that the queue won't hold any reference to the job object. </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li>iutil/<a class="el" href="job_8h-source.html">job.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>