logging.h File Reference

#include "rcl/allocator.h"
#include "rcl/arguments.h"
#include "rcl/macros.h"
#include "rcl/types.h"
#include "rcl/visibility_control.h"

Include dependency graph for logging.h:

Go to the source code of this file.

Functions
rcl_ret_t	rcl_logging_configure (const rcl_arguments_t *global_args, const rcl_allocator_t *allocator)
	Configure the logging system. More...
rcl_ret_t	rcl_logging_fini ()

Function Documentation

rcl_logging_configure()

rcl_ret_t rcl_logging_configure	(	const rcl_arguments_t *	global_args,
		const rcl_allocator_t *	allocator
	)

Configure the logging system.

This function should be called during the ROS initialization process. It will add the enabled log output appenders to the root logger.

---

Attribute	Adherence
Allocates Memory	Yes
Thread-Safe	No
Uses Atomics	No
Lock-Free	Yes

Parameters

global_args	The global arguments for the system
allocator	Used to allocate memory used by the logging system

Returns

RCL_RET_OK if successful, or

RCL_RET_BAD_ALLOC if allocating memory failed, or

RCL_RET_ERR if a general error occurs

rcl_logging_fini()

rcl_ret_t rcl_logging_fini

(

)

This function should be called to tear down the logging setup by the configure function.

---

Attribute	Adherence
Allocates Memory	No
Thread-Safe	No
Uses Atomics	No
Lock-Free	Yes

Returns

RCL_RET_OK if successful.

RCL_RET_ERR if a general error occurs