This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Namespaces

1: AclLog
2: ControlDataCommon
3: IngestUtils
4: TimeCommon
5: UUIDUtils

Namespaces

namespace AclLog
A namespace for logging utilities.
namespace ControlDataCommon
namespace IngestUtils
namespace TimeCommon
namespace UUIDUtils
A namespace for UUID utility functions.

Updated on 2022-11-17 at 15:40:06 +0100

1 - AclLog

AclLog

A namespace for logging utilities.

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	setLevel(Level level) Set global logging level.

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 setLevel

void setLevel(
    Level level
)

Set global logging level.

Parameters:

level Logging level to set

Updated on 2022-11-17 at 15:40:06 +0100

2 - ControlDataCommon

ControlDataCommon

Classes

	Name
struct	ControlDataCommon::ConnectionStatus Connection status struct containing information about a connection event.
struct	ControlDataCommon::Response A response from a ControlDataReceiver to a request. The UUID tells which receiver the response is sent from.
struct	ControlDataCommon::StatusMessage A status message from a ControlDataReceiver. The UUID tells which receiver the message is sent from.

Types

	Name
enum class	ConnectionType { CONNECTED, DISCONNECTED} The connection types.

Types Documentation

enum ConnectionType

Enumerator	Value	Description
CONNECTED
DISCONNECTED

The connection types.

Updated on 2022-11-17 at 15:40:06 +0100

3 - IngestUtils

IngestUtils

Functions

	Name
bool	isRunningWithRootPrivileges()

Functions Documentation

function isRunningWithRootPrivileges

bool isRunningWithRootPrivileges()

Return: true if this application is executing with root privileges, false otherwise

Updated on 2022-11-17 at 15:40:06 +0100

4 - TimeCommon

TimeCommon

Classes

	Name
struct	TimeCommon::TAIStatus
struct	TimeCommon::TimeStructure

Types

	Name
enum class	StratumLevel { UnknownStratum, stratum0, stratum1, stratum2, stratum3, stratum4}

Functions

	Name
uint64_t	getMonotonicClockMicro() Get current time since epoch.
TimeCommon::TAIStatus	getStatus() Get TAI status.
int64_t	getTAIMicro() Get current TAI time.
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.

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

TimeCommon::TAIStatus getStatus()

Get TAI status.

Return: Return the TAI status

function getTAIMicro

int64_t 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 2022-11-17 at 15:40:06 +0100

5 - UUIDUtils

UUIDUtils

A namespace for UUID utility functions.

Functions

	Name
std::string	generateRandomUUID() Generates a completely randomized UUID string.
bool	isValidUUIDString(const std::string & uuid) Checks if a string is a valid UUID string.

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:

uuid The string to check

Return: True if uuid is a valid UUID string, otherwise false

Updated on 2022-11-17 at 15:40:06 +0100