summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4WxProcessingController.h
blob: 0be738f13531acbe2e94a797c8829ab9e4873793 (plain)
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
/*
Copyright (C) 2018-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: Dk4WxProcessingController.cpt
*/

#ifndef DK4WXPROCESSINGCONTROLLER_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4WXPROCESSINGCONTROLLER_H_INCLUDED 1


#line 8 "Dk4WxProcessingController.cpt"

/**	@file	Dk4WxProcessingController.h	Processing controller to skip
	concurrent execution of code accessing the same variables.

	@code
	class AnyClass {
		protected:
		Dk4WxProcessingController	procon;
		...
	};

	AnyClass::SomeMethod(void)
	{
		if (procon.CanEnterCriticalSection()) {
			... Yes, we are allowed to execute code accessing variable ...
			...
			... Notify the controller that we are done ...
			procon.LeaveCriticalSection();
		}
		else {
			... No, we are not allowed to access the variables ...
		}
	}
	@endcode
*/

#ifndef	DK4CONF_H_INCLUDED
#include <dk4conf.h>
#endif

#include <wx/wxprec.h>
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif

#ifndef	WX_THREAD_H_INCLUDED
#include <wx/thread.h>
#define	WX_THREAD_H_INCLUDED 1
#endif



/**	Protect code from concurrent execution, mainly for timer handlers.
	In contrast to a critical section which delays execution of
	code to avoid concurrent access to data this class skips
	the execution of concurrent code.
*/
class Dk4WxProcessingController
{
	protected:

		/**	Critical section to protect the "in use" flag.
		*/
		wxCriticalSection	csProtect;

		/**	Flag to mark section as currently in use.
		*/
		bool				bInUse;

	public:

		/**	Constructor
		*/
		Dk4WxProcessingController(void);

		/**	Check whether the critical code section can be entered.
			@return	True if the section can be entered, false otherwise.
			If the method returns true, the bInUse flag is set, you must
			call LeaveCriticalSection() to reset it.
		*/
		bool
		CanEnterCriticalSection(void);

		/**	LeaveCriticalSection the critical section.
		*/
		void
		LeaveCriticalSection(void);

};



/* vim: set ai sw=4 ts=4 : */

#endif