rcl  master
C API providing common ROS client library functionality.
init_options.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__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 
40 RCL_PUBLIC
41 RCL_WARN_UNUSED
43 rcl_get_zero_initialized_init_options(void);
44 
46 
70 RCL_PUBLIC
71 RCL_WARN_UNUSED
72 rcl_ret_t
73 rcl_init_options_init(rcl_init_options_t * init_options, rcl_allocator_t allocator);
74 
76 
102 RCL_PUBLIC
103 RCL_WARN_UNUSED
104 rcl_ret_t
105 rcl_init_options_copy(const rcl_init_options_t * src, rcl_init_options_t * dst);
106 
108 
125 RCL_PUBLIC
126 RCL_WARN_UNUSED
127 rcl_ret_t
128 rcl_init_options_fini(rcl_init_options_t * init_options);
129 
131 
150 RCL_PUBLIC
151 RCL_WARN_UNUSED
153 rcl_init_options_get_rmw_init_options(rcl_init_options_t * init_options);
154 
156 
175 RCL_PUBLIC
176 RCL_WARN_UNUSED
177 const rcl_allocator_t *
178 rcl_init_options_get_allocator(const rcl_init_options_t * init_options);
179 
180 #ifdef __cplusplus
181 }
182 #endif
183 
184 #endif // RCL__INIT_OPTIONS_H_
rmw_init_options_t
init.h
rcl_init_options_t
Encapsulation of init options and implementation defined init options.
Definition: init_options.h:33
rcl_init_options_t::impl
struct rcl_init_options_impl_t * impl
Implementation specific pointer.
Definition: init_options.h:36
rcutils_allocator_t