<!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>libdap++: libdap::AlarmHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libdap++ <span id="projectnumber">Updated for version 3.8.2</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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="classes.html"><span>Class Index</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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlibdap_1_1AlarmHandler.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>libdap::AlarmHandler Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="libdap::AlarmHandler" --><!-- doxytag: inherits="libdap::EventHandler" -->
<p><code>#include <<a class="el" href="AlarmHandler_8h_source.html">AlarmHandler.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for libdap::AlarmHandler:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1AlarmHandler__inherit__graph.png" border="0" usemap="#libdap_1_1AlarmHandler_inherit__map" alt="Inheritance graph"/></div>
<map name="libdap_1_1AlarmHandler_inherit__map" id="libdap_1_1AlarmHandler_inherit__map">
<area shape="rect" id="node2" href="classlibdap_1_1EventHandler.html" title="{libdap::EventHandler\n||+ handle_signal()\l+ ~EventHandler()\l}" alt="" coords="5,6,227,98"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for libdap::AlarmHandler:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1AlarmHandler__coll__graph.png" border="0" usemap="#libdap_1_1AlarmHandler_coll__map" alt="Collaboration graph"/></div>
<map name="libdap_1_1AlarmHandler_coll__map" id="libdap_1_1AlarmHandler_coll__map">
<area shape="rect" id="node2" href="classlibdap_1_1EventHandler.html" title="{libdap::EventHandler\n||+ handle_signal()\l+ ~EventHandler()\l}" alt="" coords="5,6,227,98"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classlibdap_1_1AlarmHandler-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1AlarmHandler.html#a35ed5f5a237b749d58e9f5a14eb096fa">AlarmHandler</a> (FILE *s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1AlarmHandler.html#a3047870a12b2ab315b41f591c2f7e321">AlarmHandler</a> (ostream &out)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1AlarmHandler.html#abe52f8939c85b0285c2a8cb48b970a9b">handle_signal</a> (int signum)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1AlarmHandler.html#afc0167a0ce74afa5a014bba867660815">~AlarmHandler</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Handle the time out alarm. When an OPeNDAP server runs until the time out alarm is triggered, this class provides the concrete implementation of <a class="el" href="classlibdap_1_1EventHandler.html#a9cb4e0ec28ce8562067c1a9103f93559">EventHandler::handle_signal()</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classlibdap_1_1EventHandler.html">EventHandler</a> </dd>
<dd>
<a class="el" href="classlibdap_1_1SignalHandler.html">SignalHandler</a> </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>James Gallagher <<a href="mailto:jgallagher@opendap.org">jgallagher@opendap.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="AlarmHandler_8h_source.html#l00047">47</a> of file <a class="el" href="AlarmHandler_8h_source.html">AlarmHandler.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a35ed5f5a237b749d58e9f5a14eb096fa"></a><!-- doxytag: member="libdap::AlarmHandler::AlarmHandler" ref="a35ed5f5a237b749d58e9f5a14eb096fa" args="(FILE *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::AlarmHandler::AlarmHandler </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Store information to be used by the handler. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Write to this stream. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AlarmHandler_8h_source.html#l00068">68</a> of file <a class="el" href="AlarmHandler_8h_source.html">AlarmHandler.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3047870a12b2ab315b41f591c2f7e321"></a><!-- doxytag: member="libdap::AlarmHandler::AlarmHandler" ref="a3047870a12b2ab315b41f591c2f7e321" args="(ostream &out)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">libdap::AlarmHandler::AlarmHandler </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"><em>out</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="AlarmHandler_8h_source.html#l00071">71</a> of file <a class="el" href="AlarmHandler_8h_source.html">AlarmHandler.h</a>.</p>
</div>
</div>
<a class="anchor" id="afc0167a0ce74afa5a014bba867660815"></a><!-- doxytag: member="libdap::AlarmHandler::~AlarmHandler" ref="afc0167a0ce74afa5a014bba867660815" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual libdap::AlarmHandler::~AlarmHandler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="AlarmHandler_8h_source.html#l00078">78</a> of file <a class="el" href="AlarmHandler_8h_source.html">AlarmHandler.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abe52f8939c85b0285c2a8cb48b970a9b"></a><!-- doxytag: member="libdap::AlarmHandler::handle_signal" ref="abe52f8939c85b0285c2a8cb48b970a9b" args="(int signum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void libdap::AlarmHandler::handle_signal </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>signum</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handle an alarm signal. When one of our servers gets an alarm, that means it has hit its time out. We need to dump two CRLF pairs down the stream and then send an <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object explaining that a timeout has been reached.</p>
<p>Because this is a signal handler, it should call only reentrant system services, functions, et cetera. Generally that eliminates stdio functions but I'm using them anyway. This handler never returns to the code that was running when the alarm signal was raised.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">signum</td><td>We know it is SIGALRM; here as a check </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Never returns; calls exit after sending the <a class="el" href="classlibdap_1_1Error.html" title="A class for error processing.">Error</a> object. </dd></dl>
<p>Implements <a class="el" href="classlibdap_1_1EventHandler.html#a9cb4e0ec28ce8562067c1a9103f93559">libdap::EventHandler</a>.</p>
<p>Definition at line <a class="el" href="AlarmHandler_8h_source.html#l00098">98</a> of file <a class="el" href="AlarmHandler_8h_source.html">AlarmHandler.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AlarmHandler_8h_source.html">AlarmHandler.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelibdap.html">libdap</a> </li>
<li class="navelem"><a class="el" href="classlibdap_1_1AlarmHandler.html">AlarmHandler</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for libdap++ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
