rcl  master
C API providing common ROS client library functionality.
logging.h
1 // Copyright 2018 Open Source Robotics Foundation, Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef RCL__LOGGING_H_
16 #define RCL__LOGGING_H_
17 
18 #include "rcl/allocator.h"
19 #include "rcl/arguments.h"
20 #include "rcl/macros.h"
21 #include "rcl/types.h"
22 #include "rcl/visibility_control.h"
23 
24 #include "rcutils/logging.h"
25 
26 #ifdef __cplusplus
27 extern "C"
28 {
29 #endif
30 
31 typedef rcutils_logging_output_handler_t rcl_logging_output_handler_t;
32 
34 
53 RCL_PUBLIC
54 RCL_WARN_UNUSED
55 rcl_ret_t
56 rcl_logging_configure(
57  const rcl_arguments_t * global_args,
58  const rcl_allocator_t * allocator);
59 
61 
80 RCL_PUBLIC
81 RCL_WARN_UNUSED
82 rcl_ret_t
83 rcl_logging_configure_with_output_handler(
84  const rcl_arguments_t * global_args,
85  const rcl_allocator_t * allocator,
86  rcl_logging_output_handler_t output_handler);
87 
102 RCL_PUBLIC
103 RCL_WARN_UNUSED
104 rcl_ret_t rcl_logging_fini();
105 
107 
121 RCL_PUBLIC
122 RCL_WARN_UNUSED
123 bool rcl_logging_rosout_enabled();
124 
126 
140 RCL_PUBLIC
141 void
142 rcl_logging_multiple_output_handler(
143  const rcutils_log_location_t * location,
144  int severity, const char * name, rcutils_time_point_value_t timestamp,
145  const char * format, va_list * args);
146 
147 #ifdef __cplusplus
148 }
149 #endif
150 
151 #endif // RCL__LOGGING_H_
rcutils_logging_output_handler_t
void(* rcutils_logging_output_handler_t)(const rcutils_log_location_t *, int, const char *, rcutils_time_point_value_t, const char *, va_list *)
rcl_arguments_t
Hold output of parsing command line arguments.
Definition: arguments.h:32
rcutils_time_point_value_t
int64_t rcutils_time_point_value_t
rcutils_log_location_t
rcutils_allocator_t
va_list
logging.h