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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkLoggerThreadWrapper_h
#define itkLoggerThreadWrapper_h
#include <string>
#include <queue>
#include <thread>
#include <atomic>
#include "itkObjectFactory.h"
#include <mutex>
#include "ITKCommonExport.h"
namespace itk
{
/** \class LoggerThreadWrapperEnums
* \brief enums for LoggerThreadWrapper
* \ingroup ITKCommon
*/
class LoggerThreadWrapperEnums
{
public:
/** \class Operation
* \ingroup ITKCommon
* Definition of types of operations for LoggerThreadWrapper.
*/
enum class Operation : uint8_t
{
SET_PRIORITY_LEVEL,
SET_LEVEL_FOR_FLUSHING,
ADD_LOG_OUTPUT,
WRITE
};
};
// Define how to print enumeration
extern ITKCommon_EXPORT std::ostream &
operator<<(std::ostream & out, const LoggerThreadWrapperEnums::Operation value);
/** \class LoggerThreadWrapper
* \brief Used for providing logging service as a separate thread.
*
* \author Hee-Su Kim, Compute Science Dept. Kyungpook National University,
* ISIS Center, Georgetown University.
*
* \ingroup OSSystemObjects LoggingObjects
* \ingroup ITKCommon
*/
template <typename SimpleLoggerType>
class ITK_TEMPLATE_EXPORT LoggerThreadWrapper : public SimpleLoggerType
{
public:
using Self = LoggerThreadWrapper;
using Superclass = SimpleLoggerType;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(LoggerThreadWrapper);
/** New macro for creation of through a Smart Pointer */
itkNewMacro(Self);
using OutputType = typename SimpleLoggerType::OutputType;
using PriorityLevelEnum = typename SimpleLoggerType::PriorityLevelEnum;
using DelayType = unsigned int;
using OperationEnum = LoggerThreadWrapperEnums::Operation;
#if !defined(ITK_LEGACY_REMOVE)
using LoggerThreadWrapperOperationType = OperationEnum;
static constexpr OperationEnum SET_PRIORITY_LEVEL = OperationEnum::SET_PRIORITY_LEVEL;
static constexpr OperationEnum SET_LEVEL_FOR_FLUSHING = OperationEnum::SET_LEVEL_FOR_FLUSHING;
static constexpr OperationEnum ADD_LOG_OUTPUT = OperationEnum::ADD_LOG_OUTPUT;
static constexpr OperationEnum WRITE = OperationEnum::WRITE;
#endif
/** Set the priority level for the current logger. Only messages that have
* priorities equal or greater than the one set here will be posted to the
* current outputs */
void
SetPriorityLevel(PriorityLevelEnum level) override;
/** Get the priority level for the current logger. Only messages that have
* priorities equal or greater than the one set here will be posted to the
* current outputs */
PriorityLevelEnum
GetPriorityLevel() const override;
void
SetLevelForFlushing(PriorityLevelEnum level) override;
PriorityLevelEnum
GetLevelForFlushing() const override;
/** Set the delay in milliseconds between checks to see if there are any
* low priority messages to be processed.
*/
virtual void
SetDelay(DelayType delay);
/** Get the delay in milliseconds between checks to see if there are any
* low priority messages to be processed.
*/
virtual DelayType
GetDelay() const;
/** Registers another output stream with the multiple output. */
void
AddLogOutput(OutputType * output) override;
void
Write(PriorityLevelEnum level, std::string const & content) override;
void
Flush() override;
protected:
void
PrivateFlush() override;
/** Constructor */
LoggerThreadWrapper();
/** Destructor */
~LoggerThreadWrapper() override;
/** Print contents of a LoggerThreadWrapper */
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
ThreadFunction();
private:
std::thread m_Thread{};
std::atomic<bool> m_TerminationRequested{};
std::queue<OperationEnum> m_OperationQ{};
std::queue<std::string> m_MessageQ{};
std::queue<PriorityLevelEnum> m_LevelQ{};
std::queue<typename OutputType::Pointer> m_OutputQ{};
mutable std::mutex m_Mutex{};
DelayType m_Delay{};
}; // class LoggerThreadWrapper
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkLoggerThreadWrapper.hxx"
#endif
#endif // itkLoggerThreadWrapper_h
|
