libbuteosyncfw5-doc 0.7.21+16.04.20151216.1-0ubuntu1 / usr / share / doc / buteo-syncfw-doc / classSyncSigHandler.html

This file is indexed.

/usr/share/doc/buteo-syncfw-doc/classSyncSigHandler.html is in libbuteosyncfw5-doc 0.7.21+16.04.20151216.1-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<!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.9.1"/>
<title>ButeoSynchronizationFramework: SyncSigHandler 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 style="padding-left: 0.5em;">
   <div id="projectname">ButeoSynchronizationFramework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</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&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-slots">Public Slots</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classSyncSigHandler-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SyncSigHandler Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>About this class. We can't call Qt functions from Unix signal handlers.We can only call async-signal-safe functions from signal handlers. So this provides a way to use Unix signal handlers with Qt. The strategy is to have our Unix signal handler will eventually cause a Qt signal to be emitted, and then we simply return from our Unix signal handler. Back in our Qt program, that Qt signal gets emitted and then received by our Qt slot function, where we are safely doing Qt stuff which weren't allowed to do in the Unix signal handler. One simple way to make this happen is declares a socket pair in our class for each Unix signal we want to handle. The socket pairs are declared as static data members.We also created a QSocketNotifier to monitor the read end of each socket pair, declare your Unix signal handlers to be static class methods, and declare a slot function corresponding to each of our Unix signal handlers. In this class, we intend to handle both the SIGHUP and SIGTERM signals.  
 <a href="classSyncSigHandler.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="SyncSigHandler_8h_source.html">SyncSigHandler.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SyncSigHandler:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classSyncSigHandler.png" usemap="#SyncSigHandler_map" alt=""/>
  <map id="SyncSigHandler_map" name="SyncSigHandler_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr class="memitem:aceb398c8b5e5105c09ea36705011eb80"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyncSigHandler.html#aceb398c8b5e5105c09ea36705011eb80">handleSigHup</a> ()</td></tr>
<tr class="memdesc:aceb398c8b5e5105c09ea36705011eb80"><td class="mdescLeft">&#160;</td><td class="mdescRight">QT signal handler to handle SIG_HUP.  <a href="#aceb398c8b5e5105c09ea36705011eb80">More...</a><br /></td></tr>
<tr class="separator:aceb398c8b5e5105c09ea36705011eb80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fe401bf92a3aaf01ab13c7c520a4691"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyncSigHandler.html#a8fe401bf92a3aaf01ab13c7c520a4691">handleSigTerm</a> ()</td></tr>
<tr class="memdesc:a8fe401bf92a3aaf01ab13c7c520a4691"><td class="mdescLeft">&#160;</td><td class="mdescRight">QT signal handler to handle SIG_TERM.  <a href="#a8fe401bf92a3aaf01ab13c7c520a4691">More...</a><br /></td></tr>
<tr class="separator:a8fe401bf92a3aaf01ab13c7c520a4691"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a54af4198d264b92dac997dd91ab50aa9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyncSigHandler.html#a54af4198d264b92dac997dd91ab50aa9">SyncSigHandler</a> (QObject *aParent=0, const char *aName=0)</td></tr>
<tr class="memdesc:a54af4198d264b92dac997dd91ab50aa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a54af4198d264b92dac997dd91ab50aa9">More...</a><br /></td></tr>
<tr class="separator:a54af4198d264b92dac997dd91ab50aa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b344fa23255ae307f83f7daf88ba13b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyncSigHandler.html#a3b344fa23255ae307f83f7daf88ba13b">~SyncSigHandler</a> ()</td></tr>
<tr class="memdesc:a3b344fa23255ae307f83f7daf88ba13b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a3b344fa23255ae307f83f7daf88ba13b">More...</a><br /></td></tr>
<tr class="separator:a3b344fa23255ae307f83f7daf88ba13b"><td class="memSeparator" colspan="2">&#160;</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:a241a36104f9f9a719e4bd86ca661ac9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a241a36104f9f9a719e4bd86ca661ac9b"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>hupSignalHandler</b> (int unused)</td></tr>
<tr class="separator:a241a36104f9f9a719e4bd86ca661ac9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6ec26d6a131e9434fccf0ecd2af896a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6ec26d6a131e9434fccf0ecd2af896a"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>termSignalHandler</b> (int unused)</td></tr>
<tr class="separator:af6ec26d6a131e9434fccf0ecd2af896a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>About this class. We can't call Qt functions from Unix signal handlers.We can only call async-signal-safe functions from signal handlers. So this provides a way to use Unix signal handlers with Qt. The strategy is to have our Unix signal handler will eventually cause a Qt signal to be emitted, and then we simply return from our Unix signal handler. Back in our Qt program, that Qt signal gets emitted and then received by our Qt slot function, where we are safely doing Qt stuff which weren't allowed to do in the Unix signal handler. One simple way to make this happen is declares a socket pair in our class for each Unix signal we want to handle. The socket pairs are declared as static data members.We also created a QSocketNotifier to monitor the read end of each socket pair, declare your Unix signal handlers to be static class methods, and declare a slot function corresponding to each of our Unix signal handlers. In this class, we intend to handle both the SIGHUP and SIGTERM signals. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a54af4198d264b92dac997dd91ab50aa9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SyncSigHandler::SyncSigHandler </td>
          <td>(</td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>aParent</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>aName</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">aParent</td><td>object </td></tr>
    <tr><td class="paramname">aName</td><td>const char </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3b344fa23255ae307f83f7daf88ba13b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SyncSigHandler::~SyncSigHandler </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aceb398c8b5e5105c09ea36705011eb80"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SyncSigHandler::handleSigHup </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>QT signal handler to handle SIG_HUP. </p>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="a8fe401bf92a3aaf01ab13c7c520a4691"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SyncSigHandler::handleSigTerm </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>QT signal handler to handle SIG_TERM. </p>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="SyncSigHandler_8h_source.html">SyncSigHandler.h</a></li>
<li>SyncSigHandler.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 16 2015 19:19:27 for ButeoSynchronizationFramework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.