logging_macros.h File Reference

#include "rcutils/logging.h"
#include <stdio.h>
#include <stdlib.h>

Include dependency graph for logging_macros.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	RCUTILS_LOG_MIN_SEVERITY_DEBUG   0
#define	RCUTILS_LOG_MIN_SEVERITY_INFO   1
#define	RCUTILS_LOG_MIN_SEVERITY_WARN   2
#define	RCUTILS_LOG_MIN_SEVERITY_ERROR   3
#define	RCUTILS_LOG_MIN_SEVERITY_FATAL   4
#define	RCUTILS_LOG_MIN_SEVERITY_NONE   5
#define	RCUTILS_LOG_MIN_SEVERITY   RCUTILS_LOG_MIN_SEVERITY_DEBUG
#define	RCUTILS_LOG_COND_NAMED(severity, condition_before, condition_after, name, ...)
#define	RCUTILS_LOG_CONDITION_EMPTY
Macros for the `once` condition which ignores all subsequent log
calls except the first one.
#define	RCUTILS_LOG_CONDITION_ONCE_BEFORE
#define	RCUTILS_LOG_CONDITION_ONCE_AFTER
Macros for the `expression` condition which ignores the log calls
when the expression evaluates to false.
#define	RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression)   if (expression) {
#define	RCUTILS_LOG_CONDITION_EXPRESSION_AFTER   }
Macros for the `skipfirst` condition which ignores the first log
call but processes all subsequent calls.
#define	RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE
#define	RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER
Macros for the `throttle` condition which ignores log calls if the
last logged message is not longer ago than the specified duration.
#define	RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration)
#define	RCUTILS_LOG_CONDITION_THROTTLE_AFTER
Logging macros for severity DEBUG.
#define	RCUTILS_LOG_DEBUG(...)
#define	RCUTILS_LOG_DEBUG_NAMED(name, ...)
#define	RCUTILS_LOG_DEBUG_ONCE(...)
#define	RCUTILS_LOG_DEBUG_ONCE_NAMED(name, ...)
#define	RCUTILS_LOG_DEBUG_EXPRESSION(expression, ...)
#define	RCUTILS_LOG_DEBUG_EXPRESSION_NAMED(expression, name, ...)
#define	RCUTILS_LOG_DEBUG_FUNCTION(function, ...)
#define	RCUTILS_LOG_DEBUG_FUNCTION_NAMED(function, name, ...)
#define	RCUTILS_LOG_DEBUG_SKIPFIRST(...)
#define	RCUTILS_LOG_DEBUG_SKIPFIRST_NAMED(name, ...)
#define	RCUTILS_LOG_DEBUG_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_DEBUG_SKIPFIRST_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_DEBUG_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
#define	RCUTILS_LOG_DEBUG_SKIPFIRST_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
Logging macros for severity INFO.
#define	RCUTILS_LOG_INFO(...)
#define	RCUTILS_LOG_INFO_NAMED(name, ...)
#define	RCUTILS_LOG_INFO_ONCE(...)
#define	RCUTILS_LOG_INFO_ONCE_NAMED(name, ...)
#define	RCUTILS_LOG_INFO_EXPRESSION(expression, ...)
#define	RCUTILS_LOG_INFO_EXPRESSION_NAMED(expression, name, ...)
#define	RCUTILS_LOG_INFO_FUNCTION(function, ...)
#define	RCUTILS_LOG_INFO_FUNCTION_NAMED(function, name, ...)
#define	RCUTILS_LOG_INFO_SKIPFIRST(...)
#define	RCUTILS_LOG_INFO_SKIPFIRST_NAMED(name, ...)
#define	RCUTILS_LOG_INFO_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_INFO_SKIPFIRST_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_INFO_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
#define	RCUTILS_LOG_INFO_SKIPFIRST_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
Logging macros for severity WARN.
#define	RCUTILS_LOG_WARN(...)
#define	RCUTILS_LOG_WARN_NAMED(name, ...)
#define	RCUTILS_LOG_WARN_ONCE(...)
#define	RCUTILS_LOG_WARN_ONCE_NAMED(name, ...)
#define	RCUTILS_LOG_WARN_EXPRESSION(expression, ...)
#define	RCUTILS_LOG_WARN_EXPRESSION_NAMED(expression, name, ...)
#define	RCUTILS_LOG_WARN_FUNCTION(function, ...)
#define	RCUTILS_LOG_WARN_FUNCTION_NAMED(function, name, ...)
#define	RCUTILS_LOG_WARN_SKIPFIRST(...)
#define	RCUTILS_LOG_WARN_SKIPFIRST_NAMED(name, ...)
#define	RCUTILS_LOG_WARN_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_WARN_SKIPFIRST_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_WARN_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
#define	RCUTILS_LOG_WARN_SKIPFIRST_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
Logging macros for severity ERROR.
#define	RCUTILS_LOG_ERROR(...)
#define	RCUTILS_LOG_ERROR_NAMED(name, ...)
#define	RCUTILS_LOG_ERROR_ONCE(...)
#define	RCUTILS_LOG_ERROR_ONCE_NAMED(name, ...)
#define	RCUTILS_LOG_ERROR_EXPRESSION(expression, ...)
#define	RCUTILS_LOG_ERROR_EXPRESSION_NAMED(expression, name, ...)
#define	RCUTILS_LOG_ERROR_FUNCTION(function, ...)
#define	RCUTILS_LOG_ERROR_FUNCTION_NAMED(function, name, ...)
#define	RCUTILS_LOG_ERROR_SKIPFIRST(...)
#define	RCUTILS_LOG_ERROR_SKIPFIRST_NAMED(name, ...)
#define	RCUTILS_LOG_ERROR_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_ERROR_SKIPFIRST_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_ERROR_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
#define	RCUTILS_LOG_ERROR_SKIPFIRST_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
Logging macros for severity FATAL.
#define	RCUTILS_LOG_FATAL(...)
#define	RCUTILS_LOG_FATAL_NAMED(name, ...)
#define	RCUTILS_LOG_FATAL_ONCE(...)
#define	RCUTILS_LOG_FATAL_ONCE_NAMED(name, ...)
#define	RCUTILS_LOG_FATAL_EXPRESSION(expression, ...)
#define	RCUTILS_LOG_FATAL_EXPRESSION_NAMED(expression, name, ...)
#define	RCUTILS_LOG_FATAL_FUNCTION(function, ...)
#define	RCUTILS_LOG_FATAL_FUNCTION_NAMED(function, name, ...)
#define	RCUTILS_LOG_FATAL_SKIPFIRST(...)
#define	RCUTILS_LOG_FATAL_SKIPFIRST_NAMED(name, ...)
#define	RCUTILS_LOG_FATAL_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_FATAL_SKIPFIRST_THROTTLE(get_time_point_value, duration, ...)
#define	RCUTILS_LOG_FATAL_THROTTLE_NAMED(get_time_point_value, duration, name, ...)
#define	RCUTILS_LOG_FATAL_SKIPFIRST_THROTTLE_NAMED(get_time_point_value, duration, name, ...)

Macros for the `function` condition which ignores the log calls
when the function returns false.
#define	RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function)   if ((*function)()) {
#define	RCUTILS_LOG_CONDITION_FUNCTION_AFTER   }
typedef bool(*	RclLogFilter) ()

Macro Definition Documentation

RCUTILS_LOG_MIN_SEVERITY_DEBUG

#define RCUTILS_LOG_MIN_SEVERITY_DEBUG   0

RCUTILS_LOG_MIN_SEVERITY_INFO

#define RCUTILS_LOG_MIN_SEVERITY_INFO   1

RCUTILS_LOG_MIN_SEVERITY_WARN

#define RCUTILS_LOG_MIN_SEVERITY_WARN   2

RCUTILS_LOG_MIN_SEVERITY_ERROR

#define RCUTILS_LOG_MIN_SEVERITY_ERROR   3

RCUTILS_LOG_MIN_SEVERITY_FATAL

#define RCUTILS_LOG_MIN_SEVERITY_FATAL   4

RCUTILS_LOG_MIN_SEVERITY_NONE

#define RCUTILS_LOG_MIN_SEVERITY_NONE   5

RCUTILS_LOG_MIN_SEVERITY

#define RCUTILS_LOG_MIN_SEVERITY   RCUTILS_LOG_MIN_SEVERITY_DEBUG

Define RCUTILS_LOG_MIN_SEVERITY=RCUTILS_LOG_MIN_SEVERITY_[DEBUG|INFO|WARN|ERROR|FATAL] in your build options to compile out anything below that severity. Use RCUTILS_LOG_MIN_SEVERITY_NONE to compile out all macros.

RCUTILS_LOG_COND_NAMED

#define RCUTILS_LOG_COND_NAMED	(		severity,
			condition_before,
			condition_after,
			name,
			...
	)

Value:

do { \
    RCUTILS_LOGGING_AUTOINIT \
    static rcutils_log_location_t __rcutils_logging_location = {__func__, __FILE__, __LINE__}; \
    if (rcutils_logging_logger_is_enabled_for(name, severity)) { \
      condition_before \
      rcutils_log(&__rcutils_logging_location, severity, name, __VA_ARGS__); \
      condition_after \
    } \
  } while (0)

The logging macro all other logging macros call directly or indirectly.

Note

The condition will only be evaluated if this logging statement is enabled.

Parameters

severity	The severity level
condition_before	The condition macro(s) inserted before the log call
condition_after	The condition macro(s) inserted after the log call
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_CONDITION_EMPTY

#define RCUTILS_LOG_CONDITION_EMPTY

An empty macro which can be used as a placeholder for condition_before and condition_after which doesn't affect the logging call.

RCUTILS_LOG_CONDITION_ONCE_BEFORE

#define RCUTILS_LOG_CONDITION_ONCE_BEFORE

Value:

{ \
    static int __rcutils_logging_once = 0; \
    if (RCUTILS_UNLIKELY(0 == __rcutils_logging_once)) { \
      __rcutils_logging_once = 1;

A macro initializing and checking the once condition.

RCUTILS_LOG_CONDITION_ONCE_AFTER

#define RCUTILS_LOG_CONDITION_ONCE_AFTER

Value:

} \
  }

A macro finalizing the once condition.

RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE

#define RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE

(

expression

)

if (expression) {

A macro checking the expression condition.

RCUTILS_LOG_CONDITION_EXPRESSION_AFTER

#define RCUTILS_LOG_CONDITION_EXPRESSION_AFTER   }

A macro finalizing the expression condition.

RCUTILS_LOG_CONDITION_FUNCTION_BEFORE

#define RCUTILS_LOG_CONDITION_FUNCTION_BEFORE

(

function

)

if ((*function)()) {

A macro checking the function condition.

RCUTILS_LOG_CONDITION_FUNCTION_AFTER

#define RCUTILS_LOG_CONDITION_FUNCTION_AFTER   }

A macro finalizing the function condition.

RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE

#define RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE

Value:

{ \
    static bool __rcutils_logging_first = true; \
    if (RCUTILS_UNLIKELY(true == __rcutils_logging_first)) { \
      __rcutils_logging_first = false; \
    } else {

A macro initializing and checking the skipfirst condition.

RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER

#define RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER

Value:

} \
  }

A macro finalizing the skipfirst condition.

RCUTILS_LOG_CONDITION_THROTTLE_BEFORE

#define RCUTILS_LOG_CONDITION_THROTTLE_BEFORE	(		get_time_point_value,
			duration
	)

Value:

{ \
    static rcutils_duration_value_t __rcutils_logging_duration = RCUTILS_MS_TO_NS((rcutils_duration_value_t)duration); \
    static rcutils_time_point_value_t __rcutils_logging_last_logged = 0; \
    rcutils_time_point_value_t __rcutils_logging_now = 0; \
    bool __rcutils_logging_condition = true; \
    if (get_time_point_value(&__rcutils_logging_now) != RCUTILS_RET_OK) { \
      rcutils_log( \
        &__rcutils_logging_location, RCUTILS_LOG_SEVERITY_ERROR, "", \
        "%s() at %s:%d getting current steady time failed\n", \
        __func__, __FILE__, __LINE__); \
    } else { \
      __rcutils_logging_condition = __rcutils_logging_now >= __rcutils_logging_last_logged + __rcutils_logging_duration; \
    } \
 \
    if (RCUTILS_LIKELY(__rcutils_logging_condition)) { \
      __rcutils_logging_last_logged = __rcutils_logging_now;

A macro initializing and checking the throttle condition.

RCUTILS_LOG_CONDITION_THROTTLE_AFTER

#define RCUTILS_LOG_CONDITION_THROTTLE_AFTER

Value:

} \
  }

A macro finalizing the throttle condition.

RCUTILS_LOG_DEBUG

#define RCUTILS_LOG_DEBUG

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, NULL, \
    __VA_ARGS__)

Log a message with severity DEBUG.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_NAMED

#define RCUTILS_LOG_DEBUG_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, name, \
    __VA_ARGS__)

Log a message with severity DEBUG.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_ONCE

#define RCUTILS_LOG_DEBUG_ONCE

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_ONCE_NAMED

#define RCUTILS_LOG_DEBUG_ONCE_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_EXPRESSION

#define RCUTILS_LOG_DEBUG_EXPRESSION	(		expression,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_EXPRESSION_NAMED

#define RCUTILS_LOG_DEBUG_EXPRESSION_NAMED	(		expression,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_FUNCTION

#define RCUTILS_LOG_DEBUG_FUNCTION	(		function,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_FUNCTION_NAMED

#define RCUTILS_LOG_DEBUG_FUNCTION_NAMED	(		function,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_SKIPFIRST

#define RCUTILS_LOG_DEBUG_SKIPFIRST

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_SKIPFIRST_NAMED

#define RCUTILS_LOG_DEBUG_SKIPFIRST_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_THROTTLE

#define RCUTILS_LOG_DEBUG_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_SKIPFIRST_THROTTLE

#define RCUTILS_LOG_DEBUG_SKIPFIRST_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_THROTTLE_NAMED

#define RCUTILS_LOG_DEBUG_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_DEBUG_SKIPFIRST_THROTTLE_NAMED

#define RCUTILS_LOG_DEBUG_SKIPFIRST_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_DEBUG, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity DEBUG with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO

#define RCUTILS_LOG_INFO

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, NULL, \
    __VA_ARGS__)

Log a message with severity INFO.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_NAMED

#define RCUTILS_LOG_INFO_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, name, \
    __VA_ARGS__)

Log a message with severity INFO.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_ONCE

#define RCUTILS_LOG_INFO_ONCE

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_ONCE_NAMED

#define RCUTILS_LOG_INFO_ONCE_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_EXPRESSION

#define RCUTILS_LOG_INFO_EXPRESSION	(		expression,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_EXPRESSION_NAMED

#define RCUTILS_LOG_INFO_EXPRESSION_NAMED	(		expression,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_FUNCTION

#define RCUTILS_LOG_INFO_FUNCTION	(		function,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_FUNCTION_NAMED

#define RCUTILS_LOG_INFO_FUNCTION_NAMED	(		function,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_SKIPFIRST

#define RCUTILS_LOG_INFO_SKIPFIRST

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_SKIPFIRST_NAMED

#define RCUTILS_LOG_INFO_SKIPFIRST_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_THROTTLE

#define RCUTILS_LOG_INFO_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_SKIPFIRST_THROTTLE

#define RCUTILS_LOG_INFO_SKIPFIRST_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_THROTTLE_NAMED

#define RCUTILS_LOG_INFO_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_INFO_SKIPFIRST_THROTTLE_NAMED

#define RCUTILS_LOG_INFO_SKIPFIRST_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_INFO, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity INFO with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN

#define RCUTILS_LOG_WARN

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, NULL, \
    __VA_ARGS__)

Log a message with severity WARN.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_NAMED

#define RCUTILS_LOG_WARN_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, name, \
    __VA_ARGS__)

Log a message with severity WARN.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_ONCE

#define RCUTILS_LOG_WARN_ONCE

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_ONCE_NAMED

#define RCUTILS_LOG_WARN_ONCE_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_EXPRESSION

#define RCUTILS_LOG_WARN_EXPRESSION	(		expression,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_EXPRESSION_NAMED

#define RCUTILS_LOG_WARN_EXPRESSION_NAMED	(		expression,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_FUNCTION

#define RCUTILS_LOG_WARN_FUNCTION	(		function,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_FUNCTION_NAMED

#define RCUTILS_LOG_WARN_FUNCTION_NAMED	(		function,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_SKIPFIRST

#define RCUTILS_LOG_WARN_SKIPFIRST

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_SKIPFIRST_NAMED

#define RCUTILS_LOG_WARN_SKIPFIRST_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_THROTTLE

#define RCUTILS_LOG_WARN_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_SKIPFIRST_THROTTLE

#define RCUTILS_LOG_WARN_SKIPFIRST_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_THROTTLE_NAMED

#define RCUTILS_LOG_WARN_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_WARN_SKIPFIRST_THROTTLE_NAMED

#define RCUTILS_LOG_WARN_SKIPFIRST_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_WARN, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity WARN with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR

#define RCUTILS_LOG_ERROR

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, NULL, \
    __VA_ARGS__)

Log a message with severity ERROR.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_NAMED

#define RCUTILS_LOG_ERROR_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, name, \
    __VA_ARGS__)

Log a message with severity ERROR.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_ONCE

#define RCUTILS_LOG_ERROR_ONCE

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_ONCE_NAMED

#define RCUTILS_LOG_ERROR_ONCE_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_EXPRESSION

#define RCUTILS_LOG_ERROR_EXPRESSION	(		expression,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_EXPRESSION_NAMED

#define RCUTILS_LOG_ERROR_EXPRESSION_NAMED	(		expression,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_FUNCTION

#define RCUTILS_LOG_ERROR_FUNCTION	(		function,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_FUNCTION_NAMED

#define RCUTILS_LOG_ERROR_FUNCTION_NAMED	(		function,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_SKIPFIRST

#define RCUTILS_LOG_ERROR_SKIPFIRST

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_SKIPFIRST_NAMED

#define RCUTILS_LOG_ERROR_SKIPFIRST_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_THROTTLE

#define RCUTILS_LOG_ERROR_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_SKIPFIRST_THROTTLE

#define RCUTILS_LOG_ERROR_SKIPFIRST_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_THROTTLE_NAMED

#define RCUTILS_LOG_ERROR_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_ERROR_SKIPFIRST_THROTTLE_NAMED

#define RCUTILS_LOG_ERROR_SKIPFIRST_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_ERROR, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity ERROR with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL

#define RCUTILS_LOG_FATAL

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, NULL, \
    __VA_ARGS__)

Log a message with severity FATAL.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_NAMED

#define RCUTILS_LOG_FATAL_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_EMPTY, RCUTILS_LOG_CONDITION_EMPTY, name, \
    __VA_ARGS__)

Log a message with severity FATAL.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_ONCE

#define RCUTILS_LOG_FATAL_ONCE

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_ONCE_NAMED

#define RCUTILS_LOG_FATAL_ONCE_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_ONCE_BEFORE, RCUTILS_LOG_CONDITION_ONCE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• All subsequent log calls except the first one are being ignored.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_EXPRESSION

#define RCUTILS_LOG_FATAL_EXPRESSION	(		expression,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_EXPRESSION_NAMED

#define RCUTILS_LOG_FATAL_EXPRESSION_NAMED	(		expression,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression), RCUTILS_LOG_CONDITION_EXPRESSION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• Log calls are being ignored when the expression evaluates to false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

expression	The expression determining if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_FUNCTION

#define RCUTILS_LOG_FATAL_FUNCTION	(		function,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_FUNCTION_NAMED

#define RCUTILS_LOG_FATAL_FUNCTION_NAMED	(		function,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function), RCUTILS_LOG_CONDITION_FUNCTION_AFTER, name, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• Log calls are being ignored when the function returns false.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

function	The functions return value determines if the message should be logged
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_SKIPFIRST

#define RCUTILS_LOG_FATAL_SKIPFIRST

(

...

)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_SKIPFIRST_NAMED

#define RCUTILS_LOG_FATAL_SKIPFIRST_NAMED	(		name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_THROTTLE

#define RCUTILS_LOG_FATAL_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_SKIPFIRST_THROTTLE

#define RCUTILS_LOG_FATAL_SKIPFIRST_THROTTLE	(		get_time_point_value,
			duration,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, NULL, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_THROTTLE_NAMED

#define RCUTILS_LOG_FATAL_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration), RCUTILS_LOG_CONDITION_THROTTLE_AFTER, name, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

RCUTILS_LOG_FATAL_SKIPFIRST_THROTTLE_NAMED

#define RCUTILS_LOG_FATAL_SKIPFIRST_THROTTLE_NAMED	(		get_time_point_value,
			duration,
			name,
			...
	)

Value:

RCUTILS_LOG_COND_NAMED( \
    RCUTILS_LOG_SEVERITY_FATAL, \
    RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration) RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE, RCUTILS_LOG_CONDITION_THROTTLE_AFTER RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER, name, \
    __VA_ARGS__)

Log a message with severity FATAL with the following conditions:

• The first log call is being ignored but all subsequent calls are being processed.
• Log calls are being ignored if the last logged message is not longer ago than the specified duration.

Note

The conditions will only be evaluated if this logging statement is enabled.

Parameters

get_time_point_value	Function that returns rcutils_ret_t and expects a rcutils_time_point_value_t pointer.
duration	The duration of the throttle interval
name	The name of the logger
...	The format string, followed by the variable arguments for the format string

Typedef Documentation

RclLogFilter

typedef bool(* RclLogFilter) ()

The filter function signature.

Returns

true to log the message, false to ignore the message