Namespaces
Namespaces
Updated on 2023-10-03 at 14:32:11 +0200
1 - AclLog
AclLog
A namespace for logging utilities.
Classes
Types
| Name |
---|
enum class | Level { kTrace, kDebug, kInfo, kWarning, kError, kCritical, kOff} Log levels. |
Functions
| Name |
---|
void | init(const std::string & name) Initialize logging. |
void | initCommandLog(const std::string & name) Init the Rendering Engine command log. |
void | setLevel(Level level) Set global logging level. |
void | logCommand(const std::string & command) Log a command to the command log. |
AclLog::Level | getLogLevel() Internal helper function for getting the setting for the log level. |
size_t | getMaxFileSize() Internal helper function for getting the setting for the maximum size for a log file. |
size_t | getMaxLogRotations() Internal helper function for getting the setting for the maximum number of rotated log files. |
std::filesystem::path | getLogFileFullPath(const std::string & name) Internal helper function for constructing the full path name for the log file. |
std::string | getThreadName() |
Types Documentation
enum Level
Enumerator | Value | Description |
---|
kTrace | | |
kDebug | | |
kInfo | | |
kWarning | | |
kError | | |
kCritical | | |
kOff | | |
Log levels.
Functions Documentation
function init
void init(
const std::string & name
)
Initialize logging.
Parameters:
- name The name of the component (used for log prefix and filename)
By default two sinks are created. The first sink writes messages to the console. The second sink attempts to create a log file in the path set by the environment variable ACL_LOG_PATH (’/tmp’ if unset). The name of the log file is ’name-.log’. The default logging level is ‘info’ (‘debug’ for debug builds) and can be changed by setting the ACL_LOG_LEVEL environment variable.
function initCommandLog
void initCommandLog(
const std::string & name
)
Init the Rendering Engine command log.
Parameters:
- name The name of the Rendering Engine (used for filename)
function setLevel
void setLevel(
Level level
)
Set global logging level.
Parameters:
- level Logging level to set
function logCommand
void logCommand(
const std::string & command
)
Log a command to the command log.
Parameters:
- command The command to log
function getLogLevel
AclLog::Level getLogLevel()
Internal helper function for getting the setting for the log level.
Return: The wanted log level fetched from an environment variable if set, or else a default value
function getMaxFileSize
Internal helper function for getting the setting for the maximum size for a log file.
Return: The wanted maximum size of the log file fetched from an environment variable if set, or else a default value
function getMaxLogRotations
size_t getMaxLogRotations()
Internal helper function for getting the setting for the maximum number of rotated log files.
Return: The wanted number of log files to rotate fetched from an environment variable if set, or else a default value
function getLogFileFullPath
std::filesystem::path getLogFileFullPath(
const std::string & name
)
Internal helper function for constructing the full path name for the log file.
Parameters:
- name The name of the component
Return: The full path to the log file
function getThreadName
inline std::string getThreadName()
Updated on 2023-10-03 at 14:32:11 +0200
2 - ControlDataCommon
ControlDataCommon
Classes
Types
| Name |
---|
enum class | ConnectionType { CONNECTED, DISCONNECTED} The connection types. |
Types Documentation
enum ConnectionType
Enumerator | Value | Description |
---|
CONNECTED | | |
DISCONNECTED | | |
The connection types.
Updated on 2023-10-03 at 14:32:11 +0200
3 - IngestUtils
IngestUtils
Functions
Functions Documentation
function isRunningWithRootPrivileges
bool isRunningWithRootPrivileges()
Return: true if this application is executing with root privileges, false otherwise
Updated on 2023-10-03 at 14:32:11 +0200
4 - spdlog
spdlog
Updated on 2023-10-03 at 14:32:11 +0200
5 - TimeCommon
TimeCommon
Classes
Types
| Name |
---|
enum class | StratumLevel { UnknownStratum, stratum0, stratum1, stratum2, stratum3, stratum4} |
Functions
Types Documentation
enum StratumLevel
Enumerator | Value | Description |
---|
UnknownStratum | | |
stratum0 | | |
stratum1 | | |
stratum2 | | |
stratum3 | | |
stratum4 | | |
Functions Documentation
function getMonotonicClockMicro
uint64_t getMonotonicClockMicro()
Get current time since epoch.
Return: Return current time since epoch in microseconds
function getStatus
tl::expected< TimeCommon::TAIStatus, std::string > getStatus()
Get TAI status.
Return: Expected with the TAI status if successful or an error string in case something went wrong
function getTAIMicro
Get current TAI time.
Return: Return current TAI time in microseconds
function taiMicroToString
std::string taiMicroToString(
int64_t taiTimestamp
)
Converts the input TAI timestamp to a human readable string. Timestamp is converted to local time including leap seconds.
Parameters:
- taiTimestamp A TAI timestamp with microseconds resolution
Return: Return a human readable timestamp
Updated on 2023-10-03 at 14:32:11 +0200
6 - UUIDUtils
UUIDUtils
A namespace for UUID utility functions.
Functions
Functions Documentation
function generateRandomUUID
std::string generateRandomUUID()
Generates a completely randomized UUID string.
Return: A random generated UUID string
function isValidUUIDString
bool isValidUUIDString(
const std::string & uuid
)
Checks if a string is a valid UUID string.
Parameters:
Return: True if uuid is a valid UUID string, otherwise false
Updated on 2023-10-03 at 14:32:11 +0200