267 lines
12 KiB
HTML
267 lines
12 KiB
HTML
|
<!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"/>
|
||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||
|
<title>GEOS: geos::util::Interrupt Class Reference</title>
|
||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
</head>
|
||
|
<body>
|
||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
<div id="titlearea">
|
||
|
<table cellspacing="0" cellpadding="0">
|
||
|
<tbody>
|
||
|
<tr style="height: 56px;">
|
||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
<div id="projectname">GEOS
|
||
|
 <span id="projectnumber">3.9.1dev</span>
|
||
|
</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</tbody>
|
||
|
</table>
|
||
|
</div>
|
||
|
<!-- end header part -->
|
||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||
|
<div id="navrow1" class="tabs">
|
||
|
<ul class="tablist">
|
||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
<li><a href="pages.html"><span>Related Pages</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>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div id="navrow2" class="tabs2">
|
||
|
<ul class="tablist">
|
||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div id="nav-path" class="navpath">
|
||
|
<ul>
|
||
|
<li class="navelem"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1util.html">util</a></li><li class="navelem"><a class="el" href="classgeos_1_1util_1_1Interrupt.html">Interrupt</a></li> </ul>
|
||
|
</div>
|
||
|
</div><!-- top -->
|
||
|
<div class="header">
|
||
|
<div class="summary">
|
||
|
<a href="#pub-types">Public Types</a> |
|
||
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
|
<a href="classgeos_1_1util_1_1Interrupt-members.html">List of all members</a> </div>
|
||
|
<div class="headertitle">
|
||
|
<div class="title">geos::util::Interrupt Class Reference</div> </div>
|
||
|
</div><!--header-->
|
||
|
<div class="contents">
|
||
|
|
||
|
<p>Used to manage interruption requests and callbacks.
|
||
|
<a href="classgeos_1_1util_1_1Interrupt.html#details">More...</a></p>
|
||
|
|
||
|
<p><code>#include <<a class="el" href="Interrupt_8h_source.html">Interrupt.h</a>></code></p>
|
||
|
<table class="memberdecls">
|
||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
||
|
Public Types</h2></td></tr>
|
||
|
<tr class="memitem:a85fcbe09fabb7459eebfcfada96a7e3d"><td class="memItemLeft" align="right" valign="top">typedef void( </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#a85fcbe09fabb7459eebfcfada96a7e3d">Callback</a>) (void)</td></tr>
|
||
|
<tr class="separator:a85fcbe09fabb7459eebfcfada96a7e3d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
</table><table class="memberdecls">
|
||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||
|
Static Public Member Functions</h2></td></tr>
|
||
|
<tr class="memitem:ad493b6367e0a93ab02ff4133dc6e3b26"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#ad493b6367e0a93ab02ff4133dc6e3b26">request</a> ()</td></tr>
|
||
|
<tr class="separator:ad493b6367e0a93ab02ff4133dc6e3b26"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:aa58dc7810a48e3594ddca89973a49c41"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#aa58dc7810a48e3594ddca89973a49c41">cancel</a> ()</td></tr>
|
||
|
<tr class="separator:aa58dc7810a48e3594ddca89973a49c41"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a4aba8ba03cf9cf7257224751a55b3ddf"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#a4aba8ba03cf9cf7257224751a55b3ddf">check</a> ()</td></tr>
|
||
|
<tr class="separator:a4aba8ba03cf9cf7257224751a55b3ddf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a314da5e7e1674a35aaac2839054b5418"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgeos_1_1util_1_1Interrupt.html#a85fcbe09fabb7459eebfcfada96a7e3d">Callback</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#a314da5e7e1674a35aaac2839054b5418">registerCallback</a> (<a class="el" href="classgeos_1_1util_1_1Interrupt.html#a85fcbe09fabb7459eebfcfada96a7e3d">Callback</a> *cb)</td></tr>
|
||
|
<tr class="memdesc:a314da5e7e1674a35aaac2839054b5418"><td class="mdescLeft"> </td><td class="mdescRight">Register a callback that will be invoked before checking for interruption requests. <a href="#a314da5e7e1674a35aaac2839054b5418">More...</a><br /></td></tr>
|
||
|
<tr class="separator:a314da5e7e1674a35aaac2839054b5418"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ac86682735da1c4fada239db486ee289a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#ac86682735da1c4fada239db486ee289a">process</a> ()</td></tr>
|
||
|
<tr class="separator:ac86682735da1c4fada239db486ee289a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a86b07d173a2454c81a566d92d1ec0b64"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#a86b07d173a2454c81a566d92d1ec0b64">interrupt</a> ()</td></tr>
|
||
|
<tr class="separator:a86b07d173a2454c81a566d92d1ec0b64"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
</table>
|
||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
<div class="textblock"><p>Used to manage interruption requests and callbacks. </p>
|
||
|
|
||
|
<p>Definition at line <a class="el" href="Interrupt_8h_source.html#l00026">26</a> of file <a class="el" href="Interrupt_8h_source.html">Interrupt.h</a>.</p>
|
||
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
||
|
<a class="anchor" id="a85fcbe09fabb7459eebfcfada96a7e3d"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">typedef void( geos::util::Interrupt::Callback) (void)</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Definition at line <a class="el" href="Interrupt_8h_source.html#l00030">30</a> of file <a class="el" href="Interrupt_8h_source.html">Interrupt.h</a>.</p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
<a class="anchor" id="aa58dc7810a48e3594ddca89973a49c41"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">static void geos::util::Interrupt::cancel </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramname"></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</td>
|
||
|
<td class="mlabels-right">
|
||
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
<p>Cancel a pending interruption request </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a4aba8ba03cf9cf7257224751a55b3ddf"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">static bool geos::util::Interrupt::check </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramname"></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</td>
|
||
|
<td class="mlabels-right">
|
||
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
<p>Check if an interruption request is pending </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a86b07d173a2454c81a566d92d1ec0b64"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">static void geos::util::Interrupt::interrupt </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramname"></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</td>
|
||
|
<td class="mlabels-right">
|
||
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ac86682735da1c4fada239db486ee289a"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">static void geos::util::Interrupt::process </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramname"></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</td>
|
||
|
<td class="mlabels-right">
|
||
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
<p>Invoke the callback, if any. Process pending interruption, if any. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a314da5e7e1674a35aaac2839054b5418"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">static <a class="el" href="classgeos_1_1util_1_1Interrupt.html#a85fcbe09fabb7459eebfcfada96a7e3d">Callback</a>* geos::util::Interrupt::registerCallback </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="classgeos_1_1util_1_1Interrupt.html#a85fcbe09fabb7459eebfcfada96a7e3d">Callback</a> * </td>
|
||
|
<td class="paramname"><em>cb</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</td>
|
||
|
<td class="mlabels-right">
|
||
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Register a callback that will be invoked before checking for interruption requests. </p>
|
||
|
<p>NOTE that interruption request checking may happen frequently so any callback would better be quick.</p>
|
||
|
<p>The callback can be used to call <a class="el" href="classgeos_1_1util_1_1Interrupt.html#ad493b6367e0a93ab02ff4133dc6e3b26">Interrupt::request()</a> </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ad493b6367e0a93ab02ff4133dc6e3b26"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">static void geos::util::Interrupt::request </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramname"></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</td>
|
||
|
<td class="mlabels-right">
|
||
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
<p>Request interruption of operations</p>
|
||
|
<p>Operations will be terminated by a GEOSInterrupt exception at first occasion. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
<li><a class="el" href="Interrupt_8h_source.html">Interrupt.h</a></li>
|
||
|
</ul>
|
||
|
</div><!-- contents -->
|
||
|
<!-- start footer part -->
|
||
|
<hr class="footer"/><address class="footer"><small>
|
||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
</a> 1.8.11
|
||
|
</small></address>
|
||
|
</body>
|
||
|
</html>
|