<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: SignalHandler< S, O > Struct Template 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">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="struct_signal_handler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SignalHandler< S, O > Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Signal handler for Linux and Unix compatibles.
<a href="struct_signal_handler.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acd307684154846febeedf1b605f69486"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_signal_handler.html#acd307684154846febeedf1b605f69486">SignalHandler</a> (<a class="el" href="ossig_8h.html#a487b4e7d6c7251a7b9a5fa0fbeebbf86">SignalHandlerFn</a> pfn=NULL, int flags=0)</td></tr>
<tr class="memdesc:acd307684154846febeedf1b605f69486"><td class="mdescLeft"> </td><td class="mdescRight">Construct a signal handler. <a href="#acd307684154846febeedf1b605f69486">More...</a><br /></td></tr>
<tr class="separator:acd307684154846febeedf1b605f69486"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<int S, bool O = false><br />
struct SignalHandler< S, O ></h3>
<p>Signal handler for Linux and Unix compatibles. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">S</td><td>Signal number </td></tr>
<tr><td class="paramname">O</td><td>Flag indicating exsting handler should be overwriiten</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="struct_signal_handler.html#acd307684154846febeedf1b605f69486" title="Construct a signal handler. ">SignalHandler()</a> can be used to install a signal handler with the signature <code>void handler_fn(int)</code>. If <code>SignalHandlerFn</code> is not <code>NULL</code>, then the sigaction is set to the function and the sigaction flags is set to the flags. If <code>SignalHandlerFn</code> is <code>NULL</code>, then a default handler is installed using sigaction flags set to 0. The default handler only returns from the call.</p>
<p>Upon destruction the previous signal handler is restored if the former signal handler was replaced.</p>
<p>On Cygwin systems using Newlib, you should define <code>_XOPEN_SOURCE=700</code> or <code>_GNU_SOURCE</code>; or use <code>-std=gnu++03</code>, <code>-std=gnu++11</code>, or similar. If you compile with <code>-std=c++03</code>, <code>-std=c++11</code> or similar, then define <code>_XOPEN_SOURCE=700</code>. </p><dl class="section warning"><dt>Warning</dt><dd>Do not use <a class="el" href="struct_signal_handler.html" title="Signal handler for Linux and Unix compatibles. ">SignalHandler</a> in a code block that uses <code>setjmp</code> or <code>longjmp</code> because the destructor may not run. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 5.6.5 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ossig_8h.html#aa6a62d41a02cd9a63fe275cd04879571" title="Null signal handler function. ">NullSignalHandler</a>, <a class="el" href="ossig_8h.html#a487b4e7d6c7251a7b9a5fa0fbeebbf86" title="Signal handler function pointer. ">SignalHandlerFn</a>, <a class="el" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>, <a class="el" href="class_debug_trap_handler.html" title="Default SIGTRAP handler. ">DebugTrapHandler</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="ossig_8h_source.html#l00058">58</a> of file <a class="el" href="ossig_8h_source.html">ossig.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="acd307684154846febeedf1b605f69486"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd307684154846febeedf1b605f69486">◆ </a></span>SignalHandler()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<int S, bool O = false> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_signal_handler.html">SignalHandler</a>< S, O >::<a class="el" href="struct_signal_handler.html">SignalHandler</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ossig_8h.html#a487b4e7d6c7251a7b9a5fa0fbeebbf86">SignalHandlerFn</a> </td>
<td class="paramname"><em>pfn</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a signal handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pfn</td><td>Pointer to a signal handler function </td></tr>
<tr><td class="paramname">flags</td><td>Flags to use with the signal handler</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="struct_signal_handler.html#acd307684154846febeedf1b605f69486" title="Construct a signal handler. ">SignalHandler()</a> installs a signal handler with the signature <code>void handler_fn(int)</code>. If <code>SignalHandlerFn</code> is not <code>NULL</code>, then the sigaction is set to the function and the sigaction flags is set to the flags. If <code>SignalHandlerFn</code> is <code>NULL</code>, then a default handler is installed using sigaction flags set to 0. The default handler only returns from the call.</p>
<p>Upon destruction the previous signal handler is restored if the former signal handler was overwritten.</p>
<p>On Cygwin systems using Newlib, you should define <code>_XOPEN_SOURCE=700</code> or <code>_GNU_SOURCE</code>; or use <code>-std=gnu++03</code>, <code>-std=gnu++11</code>, or similar. If you compile with <code>-std=c++03</code>, <code>-std=c++11</code> or similar, then define <code>_XOPEN_SOURCE=700</code>. </p><dl class="section warning"><dt>Warning</dt><dd>Do not use <a class="el" href="struct_signal_handler.html" title="Signal handler for Linux and Unix compatibles. ">SignalHandler</a> in a code block that uses <code>setjmp</code> or <code>longjmp</code> because the destructor may not run. <code>setjmp</code> is why <a class="el" href="cpu_8cpp_source.html">cpu.cpp</a> does not use <a class="el" href="struct_signal_handler.html" title="Signal handler for Linux and Unix compatibles. ">SignalHandler</a> during CPU feature testing. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 5.6.5 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ossig_8h_source.html#l00078">78</a> of file <a class="el" href="ossig_8h_source.html">ossig.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="ossig_8h_source.html">ossig.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:57 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
3099
