fpsdk::common::logging Namespace Reference

Logging. More...

Classes
struct	LoggingParams
	Logging parameters. More...

Typedefs
using	LoggingWriteFunc = void (*)(const LoggingParams& params, const LoggingLevel level, const char* str)
	Custom logging write (to screen, file, ...) function signature.

Enumerations
enum class	LoggingLevel : int {   FATAL = 2 , ERROR = 3 , WARNING = 4 , NOTICE = 5 ,   INFO = 6 , DEBUG = 7 , TRACE = 8 }
	Logging verbosity levels, default is INFO. More...
enum class	LoggingColour { AUTO = 0 , YES , NO , JOURNAL }
	Logging "colours". More...
enum class	LoggingTimestamps { NONE = 0 , RELATIVE , ABSOLUTE }
	Logging timestamps. More...

Functions
LoggingLevel &	operator++ (LoggingLevel &level)
	Increase verbosity (pre-increment)
LoggingLevel &	operator-- (LoggingLevel &level)
	Decrease verbosity (pre-decrement)
LoggingLevel	operator++ (LoggingLevel &level, int)
	Increase verbosity (post-increment)
LoggingLevel	operator-- (LoggingLevel &level, int)
	Decrease verbosity (post-decrement)
const char *	LoggingLevelStr (const LoggingLevel level)
	Stringify log level.
bool	LoggingIsLevel (const LoggingLevel level)
	Check if given level would print.
const char *	LoggingColourStr (const LoggingColour colour)
	Stringify log level.
const char *	LoggingTimestampsStr (const LoggingTimestamps timestamps)
	Stringify log level.
void	LoggingDefaultWriteFn (const LoggingParams &params, const LoggingLevel level, const char *str)
	Default logging write function.
LoggingParams	LoggingSetParams (const LoggingParams &params)
	Configure logging.
LoggingParams	LoggingGetParams ()
	Get current logging params.
void	LoggingPrint (const LoggingLevel level, const std::size_t repeat, const char *fmt,...) PRINTF_ATTR(3)
	Print a log message.
void	LoggingHexdump (const LoggingLevel level, const uint8_t *data, const std::size_t size, const char *prefix, const char *fmt,...) PRINTF_ATTR(5)
	Print a hexdump.

Detailed Description

Logging.

Typedef Documentation

LoggingWriteFunc

using fpsdk::common::logging::LoggingWriteFunc = void (*)(const LoggingParams& params, const LoggingLevel level, const char* str)

Custom logging write (to screen, file, ...) function signature.

Parameters

[in]	params	Logging parameters
[in]	level	Logging level for the message
[in]	str	The message

Definition at line 280 of file logging.hpp.

Enumeration Type Documentation

LoggingLevel

enum class fpsdk::common::logging::LoggingLevel : int

strong

Logging verbosity levels, default is INFO.

The logging levels loosely follow syslog levels (indicated in [] below, see also https://en.wikipedia.org/wiki/Syslog)

Libraries (fpsdk_common, fpsdk_ros1, ...) code shall only use WARNING and DEBUG.

Enumerator
FATAL	[2/crit] Hard errors, critical conditions (for apps). Cannot be silenced.
ERROR	[3/err] Errors (for apps)
WARNING	[4/warning] Warnings (for libs and apps)
NOTICE	[5/notice] Significant stuff, for example headings (for apps)
INFO	[6/info] Interesting stuff, the default level (for apps)
DEBUG	[7/debug] Debugging (for libs and apps)
TRACE	[7/debug] Extra debugging, only compiled-in in non-Release builds

Definition at line 198 of file logging.hpp.

LoggingColour

enum class fpsdk::common::logging::LoggingColour

strong

Logging "colours".

Enumerator
AUTO	Automatic (default), use colours if stderr is an interactive terminal.
YES	Use colours (terminal escape sequences)
NO	Do not use colours.
JOURNAL	Use systemd journal level indicators (instead of terminal colours), useful for systemd services.

Definition at line 235 of file logging.hpp.

LoggingTimestamps

enum class fpsdk::common::logging::LoggingTimestamps

strong

Logging timestamps.

Enumerator
NONE	No timestamps.
RELATIVE	Relative timestamps (since first logging message, sssss.sss format)
ABSOLUTE	Absolute timestamps (local time, yyyy-mm-dd hh::mm:ss.sss format)

Definition at line 255 of file logging.hpp.

Function Documentation

LoggingLevelStr()

const char * fpsdk::common::logging::LoggingLevelStr

(

const LoggingLevel

level

)

Stringify log level.

Parameters

[in]

level

The logging level

Returns

a unique string identifying the level

LoggingIsLevel()

bool fpsdk::common::logging::LoggingIsLevel

(

const LoggingLevel

level

)

Check if given level would print.

Parameters

[in]

level

The logging level in question

Returns

true if the given level would print, false otherwise

LoggingColourStr()

const char * fpsdk::common::logging::LoggingColourStr

(

const LoggingColour

colour

)

Stringify log level.

Parameters

[in]

colour

The logging colour

Returns

a unique string identifying the level

LoggingTimestampsStr()

const char * fpsdk::common::logging::LoggingTimestampsStr

(

const LoggingTimestamps

timestamps

)

Stringify log level.

Parameters

[in]

timestamps

The logging timestamps

Returns

a unique string identifying the level

LoggingDefaultWriteFn()

void fpsdk::common::logging::LoggingDefaultWriteFn	(	const LoggingParams &	params,
		const LoggingLevel	level,
		const char *	str )

Default logging write function.

Parameters

[in]	params	Logging parameters
[in]	level	Logging level for the message
[in]	str	The message

LoggingSetParams()

LoggingParams fpsdk::common::logging::LoggingSetParams

(

const LoggingParams &

params

)

Configure logging.

Parameters

[in]

params

Logging parameters

Examples:

LoggingSetParams({ LoggingLevel::DEBUG });
LoggingSetParams({ LoggingLevel::DEBUG, LoggingColour::YES });
LoggingSetParams({ LoggingLevel::DEBUG, LoggingColour::AUTO, LoggingTimestamps::RELATIVE });

Returns

a copy of the applied logging parameters

LoggingGetParams()

LoggingParams fpsdk::common::logging::LoggingGetParams

(

)

Get current logging params.

Returns

a copy of the current logging params

LoggingPrint()

void fpsdk::common::logging::LoggingPrint	(	const LoggingLevel	level,
		const std::size_t	repeat,
		const char *	fmt,
			... )

Print a log message.

Note

Use INFO(), DEBUG(), WARNING() etc. instead of this function.

Parameters

[in]	level	Logging level
[in]	repeat	Number of times the message was repeated (for DEBUG_THR() etc.)
[in]	fmt	printf() style format string and optional arguments to the format string

References PRINTF_ATTR.

LoggingHexdump()

void fpsdk::common::logging::LoggingHexdump	(	const LoggingLevel	level,
		const uint8_t *	data,
		const std::size_t	size,
		const char *	prefix,
		const char *	fmt,
			... )

Print a hexdump.

Note

Typically, use DEBUG_HEXDUMP() or TRACE_HEXDUMP() instead of this function.

Parameters

[in]	level	Logging level
[in]	data	Pointer to start of data to dump
[in]	size	Size of data to dump
[in]	prefix	Prefix to add to each line, can be NULL to omit
[in]	fmt	printf() style format string, can be NULL to omit
[in]	...	printf() style format arguments

References LoggingHexdump(), and PRINTF_ATTR.

Referenced by LoggingHexdump().