Function rcl_logging_configure_with_output_handler

Function Documentation

rcl_ret_t rcl_logging_configure_with_output_handler(const rcl_arguments_t *global_args, const rcl_allocator_t *allocator, rcl_logging_output_handler_t output_handler)

Configure the logging system with the provided output handler.

Similar to rcl_logging_configure, but it uses the provided output handler.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:
  • global_args[in] The global arguments for the system

  • allocator[in] Used to allocate memory used by the logging system

  • output_handler[in] Output handler to be installed

Returns:

RCL_RET_OK if successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

RCL_RET_ERROR if a general error occurs