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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/*
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2020 Gothel Software e.K.
* Copyright (c) 2020 ZAFENA AB
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef DBT_ENV_HPP_
#define DBT_ENV_HPP_
#include <cstdint>
#include <cinttypes>
#include <cstring>
#include <string>
#include <cstdio>
extern "C" {
#include <errno.h>
}
#include "BasicTypes.hpp"
namespace direct_bt {
/**
* Base direct_bt environment class,
* merely to tag all environment settings by inheritance and hence documentation.
* <p>
* See main direct_bt environment {@link DBTEnv} and
* {@link DBTEnv::getExplodingProperties(const std::string & prefixDomain)}.
* </p>
*/
class DBTEnvrionment {
};
/**
* Main direct_bt environment class,
* supporting environment variable access and fetching elapsed time using its stored startup-time.
*/
class DBTEnv : public DBTEnvrionment {
private:
DBTEnv();
static bool debug;
static void envSet(std::string prefixDomain, std::string basepair);
static void envExplodeProperties(std::string prefixDomain, std::string list);
public:
/**
* Module startup time t0 in monotonic time in milliseconds.
*/
static const uint64_t startupTimeMilliseconds;
/**
* Returns current elapsed monotonic time in milliseconds since module startup, see {@link #startupTimeMilliseconds}.
*/
static uint64_t getElapsedMillisecond() {
return getCurrentMilliseconds() - startupTimeMilliseconds;
}
/**
* Returns the value of the environment's variable 'name'.
* <p>
* Note that only '[org.]tinyb.*' and 'direct_bt.*' Java JVM properties are passed via 'org.tinyb.BluetoothFactory'
* </p>
*/
static std::string getProperty(const std::string & name);
/**
* Returns the value of the environment's variable 'name',
* or the 'default_value' if the environment variable's value is null.
* <p>
* Implementation uses {@link #getProperty(const std::string & name)}
* </p>
*/
static std::string getProperty(const std::string & name, const std::string & default_value);
/**
* Returns the boolean value of the environment's variable 'name',
* or the 'default_value' if the environment variable's value is null.
* <p>
* If the environment variable is set (value != null),
* true is determined if the value equals 'true'.
* </p>
* <p>
* Implementation uses {@link #getProperty(const std::string & name)}.
* </p>
*/
static bool getBooleanProperty(const std::string & name, const bool default_value);
/**
* Returns the int32_t value of the environment's variable 'name',
* or the 'default_value' if the environment variable's value is null
* or not within int32_t value range or within the given value range.
* <p>
* Implementation uses {@link #getProperty(const std::string & name)}
* </p>
*/
static int32_t getInt32Property(const std::string & name, const int32_t default_value,
const int32_t min_allowed=INT32_MIN, const int32_t max_allowed=INT32_MAX);
/**
* Returns the uint32_t value of the environment's variable 'name',
* or the 'default_value' if the environment variable's value is null
* or not within uint32_t value range or within the given value range.
* <p>
* Implementation uses {@link #getProperty(const std::string & name)}
* </p>
*/
static uint32_t getUint32Property(const std::string & name, const uint32_t default_value,
const uint32_t min_allowed=0, const uint32_t max_allowed=UINT32_MAX);
/**
* Fetches exploding variable-name (prefixDomain) values.
* <p>
* If the value of a prefixDomain is neither 'true' or 'false',
* it is treated as a list of sub-variable names including their optional value separated by comma ','.
* <p>
* If the value is not given for the sub-variable name, a boolean "true" will be used per default.
* </p>
* <p>
* Example 1
* <pre>
* Input Environment:
* "direct_bt.debug" := "hci.event,mgmt.event=true,gatt.data=false"
*
* Result Environment:
* "direct_bt.debug.hci.event" := "true"
* "direct_bt.debug.mgmt.event" := "true"
* "direct_bt.debug.gatt.data" := "false"
* "direct_bt.debug" := "true" (will be overwritten)
* </pre>
* Example 2
* <pre>
* Input Environment:
* "direct_bt.gatt" := "cmd.read.timeout=20000,cmd.write.timeout=20001,ringsize=256"
*
* Result Environment:
* "direct_bt.gatt.cmd.read.timeout" := "20000"
* "direct_bt.gatt.cmd.write.timeout" := "20001"
* "direct_bt.gatt.ringsize" := "256"
* "direct_bt.gatt" := "true" (will be overwritten)
* </pre>
* </p>
* <p>
* Each sub-variable name/value pair will be trimmed and if not zero-length
* appended to the prefixDomain with a dot '.'.</br>
*
* Each new variable name will be set in the environment with value 'true'.</br>
*
* The prefixDomain will also be set to the new value 'true', hence gets overwritten.</br>
*
* This is supported for DEBUG 'direct_bt.debug' and VERBOSE 'direct_bt.verbose', pre default.
* </p>
*
* @param prefixDomain
* @return
*/
static bool getExplodingProperties(const std::string & prefixDomain);
static DBTEnv& get() {
/**
* Thread safe starting with C++11 6.7:
*
* If control enters the declaration concurrently while the variable is being initialized,
* the concurrent execution shall wait for completion of the initialization.
*
* (Magic Statics)
*
* Avoiding non-working double checked locking.
*/
static DBTEnv e;
return e;
}
/**
* Debug logging enabled or disabled.
* <p>
* Environment variable 'direct_bt.debug', boolean, default 'false'.
* </p>
* <p>
* Implementation uses {@link #getProperty(const std::string & name)}
* </p>
* <p>
* Exploding variable-name values are implemented here,
* see {@link #getExplodingProperties(const std::string & prefixDomain)}.
* </p>
*/
const bool DEBUG;
/**
* Verbose info logging enabled or disabled.
* <p>
* Environment variable 'direct_bt.verbose', boolean, default 'false'.
* </p>
* <p>
* Implementation uses {@link #getProperty(const std::string & name)}
* </p>
* <p>
* VERBOSE is also enabled if DEBUG is enabled!
* </p>
* <p>
* Exploding variable-name values are implemented here,
* see {@link #getExplodingProperties(const std::string & prefixDomain)}.
* </p>
*/
const bool VERBOSE;
};
} // namespace direct_bt
#endif /* DBT_ENV_HPP_ */
|
