summaryrefslogtreecommitdiff
path: root/support/dktools/DkWxProcessingIdleController.h
blob: c09230cf4eb907bc784531d57cc68301faec506a (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
/*
Copyright (C) 2013-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: DkWxProcessingIdleController.cpt
*/

/**	@file DkWxProcessingIdleController.h Header file for the DkWxProcessingIdleController module.
*/

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


#line 8 "DkWxProcessingIdleController.cpt"

#ifndef	DK3CONF_H_INCLUDED
#include "dk3conf.h"
#endif

#ifndef	DKWXPROCESSINGCONTROLLER_H_INCLUDED
#include <DkWxProcessingController.h>
#endif


/**	Protect idle event handler from concurrent execution.
	In contrast to a critical section which delays execution of
	code this class skips the code execution.
*/
class DkWxProcessingIdleController : public DkWxProcessingController
{
  protected:

    /**	Avoid concurrent access to bWantMore.
    */
    wxMutex		mxProtectWantMore;

    /**	Flag: More idle events wanted.
    */
    bool		bWantMore;

  public:

    /**	Constructor.
    */
    DkWxProcessingIdleController();

    /**	Indicate interest in more idle events (thread-safe).
    	@param	value	New flag value.
    */
    void	setWantMore(bool value = true);

    /**	Indicate no more interest in further idle events (thread-safe).
    */
    void	resetWantMore(void);

    /**	Check for interest in further idle events (thread-safe).
    	@return	true to ask for further events, false otherwise.
    */
    bool	wantMore(void);

};



#endif