rcl  master
C API providing common ROS client library functionality.
init_options.h
Go to the documentation of this file.
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__INIT_OPTIONS_H_
16 #define RCL__INIT_OPTIONS_H_
17 
18 #ifdef __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include "rmw/init.h"
24 
25 #include "rcl/allocator.h"
26 #include "rcl/macros.h"
27 #include "rcl/types.h"
28 #include "rcl/visibility_control.h"
29 
30 struct rcl_init_options_impl_t;
31 
33 typedef struct rcl_init_options_t
34 {
36  struct rcl_init_options_impl_t * impl;
38 
44 
46 
74 
76 
104 rcl_ret_t
106 
108 
127 rcl_ret_t
129 
131 
154 
155 #ifdef __cplusplus
156 }
157 #endif
158 
159 #endif // RCL__INIT_OPTIONS_H_
rmw_ret_t rcl_ret_t
Definition: types.h:20
struct rcl_init_options_t rcl_init_options_t
Encapsulation of init options and implementation defined init options.
rcl_init_options_t rcl_get_zero_initialized_init_options(void)
Return a zero initialized rcl_init_options_t struct.
rmw_init_options_t * rcl_init_options_get_rmw_init_options(rcl_init_options_t *init_options)
Return the rmw init options which are stored internally.
#define RCL_WARN_UNUSED
Ignored return values of functions with this macro will emit a warning.
Definition: macros.h:25
#define RCL_PUBLIC
Definition: visibility_control.h:48
Encapsulation of init options and implementation defined init options.
Definition: init_options.h:33
struct rcl_init_options_impl_t * impl
Implementation specific pointer.
Definition: init_options.h:36
rcl_ret_t rcl_init_options_fini(rcl_init_options_t *init_options)
Finalize the given init_options.
rcl_ret_t rcl_init_options_copy(const rcl_init_options_t *src, rcl_init_options_t *dst)
Copy the given source init_options to the destination init_options.
rcl_ret_t rcl_init_options_init(rcl_init_options_t *init_options, rcl_allocator_t allocator)
Initialize given init_options with the default values and implementation specific values...