Skip to content

Commit 8c4877a

Browse files
berndporrberndporr
committed
Added docs
1 parent b72a7e7 commit 8c4877a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+5021
-52
lines changed

‎CppTimer.cpp‎

Lines changed: 44 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,20 @@
44
* GNU GENERAL PUBLIC LICENSE
55
* Version 3, 29 June 2007
66
*
7-
* (C) 2020, Bernd Porr <mail@bernporr.me.uk>
7+
* (C) 2020-2021, Bernd Porr <mail@bernporr.me.uk>
88
*
99
* This is inspired by the timer_create man page.
1010
**/
1111

12-
CppTimer::CppTimer(const int signo) {
12+
CppTimer::CppTimer(const int signo)
13+
{
1314
// We create a static handler catches the signal SIG
1415
sa.sa_flags = SA_SIGINFO;
1516
sa.sa_sigaction = handler;
1617
sigemptyset(&sa.sa_mask);
1718
if (sigaction(signo, &sa, NULL) == -1)
1819
throw("Could not create signal handler");
19-
20+
2021
// Create the timer
2122
sev.sigev_notify = SIGEV_SIGNAL;
2223
sev.sigev_signo = signo;
@@ -28,49 +29,54 @@ CppTimer::CppTimer(const int signo) {
2829
throw("Could not create timer");
2930
}
3031

31-
void CppTimer::startns(long nanosecs, cppTimerType_t type) {
32-
switch(type){
33-
case(PERIODIC):
34-
//starts after specified period of nanoseconds
35-
its.it_value.tv_sec = nanosecs / 1000000000;
36-
its.it_value.tv_nsec = nanosecs % 1000000000;
37-
its.it_interval.tv_sec = nanosecs / 1000000000;
38-
its.it_interval.tv_nsec = nanosecs % 1000000000;
39-
break;
40-
case(ONESHOT):
41-
//fires once after specified period of nanoseconds
42-
its.it_value.tv_sec = nanosecs / 1000000000;
43-
its.it_value.tv_nsec = nanosecs % 1000000000;
44-
its.it_interval.tv_sec = 0;
45-
its.it_interval.tv_nsec = 0;
46-
break;
32+
void CppTimer::startns(long nanosecs, cppTimerType_t type)
33+
{
34+
switch (type)
35+
{
36+
case (PERIODIC):
37+
//starts after specified period of nanoseconds
38+
its.it_value.tv_sec = nanosecs / 1000000000;
39+
its.it_value.tv_nsec = nanosecs % 1000000000;
40+
its.it_interval.tv_sec = nanosecs / 1000000000;
41+
its.it_interval.tv_nsec = nanosecs % 1000000000;
42+
break;
43+
case (ONESHOT):
44+
//fires once after specified period of nanoseconds
45+
its.it_value.tv_sec = nanosecs / 1000000000;
46+
its.it_value.tv_nsec = nanosecs % 1000000000;
47+
its.it_interval.tv_sec = 0;
48+
its.it_interval.tv_nsec = 0;
49+
break;
4750
}
4851
if (timer_settime(timerid, 0, &its, NULL) == -1)
4952
throw("Could not start timer");
5053
}
5154

52-
void CppTimer::startms(long millisecs, cppTimerType_t type){
53-
switch(type){
54-
case(PERIODIC):
55-
//starts after specified period of milliseconds
56-
its.it_value.tv_sec = millisecs / 1000;
57-
its.it_value.tv_nsec = (millisecs % 1000) * 1000000;
58-
its.it_interval.tv_sec = millisecs / 1000;
59-
its.it_interval.tv_nsec = (millisecs % 1000) * 1000000;
60-
break;
61-
case(ONESHOT):
62-
//fires once after specified period of milliseconds
63-
its.it_value.tv_sec = millisecs / 1000;
64-
its.it_value.tv_nsec = (millisecs % 1000) * 1000000;
65-
its.it_interval.tv_sec = 0;
66-
its.it_interval.tv_nsec = 0;
67-
break;
55+
void CppTimer::startms(long millisecs, cppTimerType_t type)
56+
{
57+
switch (type)
58+
{
59+
case (PERIODIC):
60+
//starts after specified period of milliseconds
61+
its.it_value.tv_sec = millisecs / 1000;
62+
its.it_value.tv_nsec = (millisecs % 1000) * 1000000;
63+
its.it_interval.tv_sec = millisecs / 1000;
64+
its.it_interval.tv_nsec = (millisecs % 1000) * 1000000;
65+
break;
66+
case (ONESHOT):
67+
//fires once after specified period of milliseconds
68+
its.it_value.tv_sec = millisecs / 1000;
69+
its.it_value.tv_nsec = (millisecs % 1000) * 1000000;
70+
its.it_interval.tv_sec = 0;
71+
its.it_interval.tv_nsec = 0;
72+
break;
6873
}
6974
if (timer_settime(timerid, 0, &its, NULL) == -1)
7075
throw("Could not start timer");
7176
}
7277

73-
void CppTimer::stop() {
78+
void CppTimer::stop()
79+
{
7480
// disarm
7581
struct itimerspec itsnew;
7682
itsnew.it_value.tv_sec = 0;
@@ -80,7 +86,8 @@ void CppTimer::stop() {
8086
timer_settime(timerid, 0, &itsnew, &its);
8187
}
8288

83-
CppTimer::~CppTimer() {
89+
CppTimer::~CppTimer()
90+
{
8491
stop();
8592
// delete the timer
8693
timer_delete(timerid);

‎CppTimer.h‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* GNU GENERAL PUBLIC LICENSE
66
* Version 3, 29 June 2007
77
*
8-
* (C) 2020, Bernd Porr <mail@bernporr.me.uk>
8+
* (C) 2020-2021, Bernd Porr <mail@bernporr.me.uk>
99
*
1010
* This is inspired by the timer_create man page.
1111
**/
@@ -20,8 +20,9 @@
2020

2121
/**
2222
* Enumeration of CppTimer types
23-
**/
24-
enum cppTimerType_t {
23+
**/
24+
enum cppTimerType_t
25+
{
2526
PERIODIC,
2627
ONESHOT
2728
};
@@ -30,14 +31,16 @@ enum cppTimerType_t {
3031
* Timer class which repeatedly fires. It's wrapper around the
3132
* POSIX per-process timer.
3233
**/
33-
class CppTimer {
34+
class CppTimer
35+
{
3436

3537
public:
3638
/**
3739
* Creates an instance of the timer and connects the
3840
* signal handler to the timer. The default signal which
3941
* is being used is SIGRTMIN but can be changed to other
4042
* signals if other processes / threads use them.
43+
* @param signo The signal used by the timer.
4144
**/
4245
CppTimer(const int signo = SIGRTMIN);
4346

@@ -47,17 +50,21 @@ class CppTimer {
4750
* that interval in PERIODIC mode. In ONESHOT mode
4851
* the timer fires once after the specified time in
4952
* nanoseconds.
53+
* @param nanosecs Time in nanoseconds
54+
* @param type Either PERIODIC or ONESHOT
5055
**/
51-
virtual void startns(long nanosecs, cppTimerType_t type = PERIODIC);
56+
virtual void startns(long nanosecs, cppTimerType_t type = PERIODIC);
5257

5358
/**
5459
* Starts the timer. The timer fires first after
5560
* the specified time in milliseconds and then at
5661
* that interval in PERIODIC mode. In ONESHOT mode
5762
* the timer fires once after the specified time in
5863
* milliseconds.
64+
* @param millisecs Time in milliseconds
65+
* @param type Either PERIODIC or ONESHOT
5966
**/
60-
virtual void startms(long millisecs, cppTimerType_t type = PERIODIC);
67+
virtual void startms(long millisecs, cppTimerType_t type = PERIODIC);
6168

6269
/**
6370
* Stops the timer by disarming it. It can be re-started
@@ -83,11 +90,11 @@ class CppTimer {
8390
struct sigevent sev;
8491
struct sigaction sa;
8592
struct itimerspec its;
86-
87-
inline static void handler(int, siginfo_t *si, void*) {
88-
(reinterpret_cast<CppTimer *> (si->si_value.sival_ptr))->timerEvent();
93+
94+
inline static void handler(int, siginfo_t *si, void *)
95+
{
96+
(reinterpret_cast<CppTimer *>(si->si_value.sival_ptr))->timerEvent();
8997
}
9098
};
9199

92-
93100
#endif

‎demo_runnable.cpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ int main( int, const char**) {
2323
CppTimerCallback demoTimer1;
2424
Callback1 callback1;
2525
demoTimer1.registerEventRunnable(callback1);
26-
demoTimer1.startns(2500000);
26+
demoTimer1.startns(250000000);
2727
CppTimerCallback demoTimer2;
2828
Callback2 callback2;
2929
demoTimer2.registerEventRunnable(callback2);
30-
demoTimer2.startns(10000000);
30+
demoTimer2.startms(1000);
3131

3232
// do nothing and keep sleeping for 2 secs
3333
std::this_thread::sleep_for(std::chrono::seconds(2));
34-
34+
3535
demoTimer1.unregisterEventRunnable();
3636
demoTimer1.stop();
37-
37+
3838
demoTimer2.unregisterEventRunnable();
3939
demoTimer2.stop();
40-
40+
4141
printf("\n");
4242

4343
}

‎docs/CppTimerCallback_8h_source.html‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>CppTimer: CppTimerCallback.h Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">CppTimer
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
</div><!-- top -->
46+
<!-- window showing the filter options -->
47+
<div id="MSearchSelectWindow"
48+
onmouseover="return searchBox.OnSearchSelectShow()"
49+
onmouseout="return searchBox.OnSearchSelectHide()"
50+
onkeydown="return searchBox.OnSearchSelectKey(event)">
51+
</div>
52+
53+
<!-- iframe showing the search results (closed by default) -->
54+
<div id="MSearchResultsWindow">
55+
<iframe src="javascript:void(0)" frameborder="0"
56+
name="MSearchResults" id="MSearchResults">
57+
</iframe>
58+
</div>
59+
60+
<div class="header">
61+
<div class="headertitle">
62+
<div class="title">CppTimerCallback.h</div> </div>
63+
</div><!--header-->
64+
<div class="contents">
65+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef __CPP_TIMER_CALLBACK</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __CPP_TIMER_CALLBACK</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;CppTimer.h&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;unistd.h&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="classCppTimerCallback.html"> 8</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCppTimerCallback.html">CppTimerCallback</a> : <span class="keyword">public</span> <a class="code" href="classCppTimer.html">CppTimer</a> {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classCppTimerCallback_1_1Runnable.html"> 11</a></span>&#160; <span class="keyword">class </span><a class="code" href="classCppTimerCallback_1_1Runnable.html">Runnable</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> run() = 0;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; };</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordtype">void</span> registerEventRunnable(<a class="code" href="classCppTimerCallback_1_1Runnable.html">Runnable</a> &amp;h) {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; cppTimerEventRunnable = &amp;h;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; }</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordtype">void</span> unregisterEventRunnable() {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; cppTimerEventRunnable = NULL;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; }</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classCppTimerCallback.html#af6b39f5eb8e98bfc1b301ac3f25276e9"> 24</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCppTimerCallback.html#af6b39f5eb8e98bfc1b301ac3f25276e9">timerEvent</a>() {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">if</span> (cppTimerEventRunnable) {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; cppTimerEventRunnable-&gt;run();</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; }</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classCppTimerCallback_1_1Runnable.html">Runnable</a>* cppTimerEventRunnable = NULL;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;};</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classCppTimer_html"><div class="ttname"><a href="classCppTimer.html">CppTimer</a></div><div class="ttdef"><b>Definition:</b> CppTimer.h:34</div></div>
66+
<div class="ttc" id="classCppTimerCallback_html_af6b39f5eb8e98bfc1b301ac3f25276e9"><div class="ttname"><a href="classCppTimerCallback.html#af6b39f5eb8e98bfc1b301ac3f25276e9">CppTimerCallback::timerEvent</a></div><div class="ttdeci">void timerEvent()</div><div class="ttdef"><b>Definition:</b> CppTimerCallback.h:24</div></div>
67+
<div class="ttc" id="classCppTimerCallback_html"><div class="ttname"><a href="classCppTimerCallback.html">CppTimerCallback</a></div><div class="ttdef"><b>Definition:</b> CppTimerCallback.h:8</div></div>
68+
<div class="ttc" id="classCppTimerCallback_1_1Runnable_html"><div class="ttname"><a href="classCppTimerCallback_1_1Runnable.html">CppTimerCallback::Runnable</a></div><div class="ttdef"><b>Definition:</b> CppTimerCallback.h:11</div></div>
69+
</div><!-- fragment --></div><!-- contents -->
70+
<!-- start footer part -->
71+
<hr class="footer"/><address class="footer"><small>
72+
Generated on Mon Apr 12 2021 11:47:35 for CppTimer by &#160;<a href="http://www.doxygen.org/index.html">
73+
<img class="footer" src="doxygen.png" alt="doxygen"/>
74+
</a> 1.8.13
75+
</small></address>
76+
</body>
77+
</html>

0 commit comments

Comments
 (0)