rcl  beta1
C API providing common ROS client library functionality.
rcl.h
Go to the documentation of this file.
1 // Copyright 2014 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 
59 #ifndef RCL__RCL_H_
60 #define RCL__RCL_H_
61 
62 #if __cplusplus
63 extern "C"
64 {
65 #endif
66 
67 #include "rcl/macros.h"
68 #include "rcl/node.h"
69 #include "rcl/publisher.h"
70 #include "rcl/subscription.h"
71 #include "rcl/types.h"
72 #include "rcl/wait.h"
73 #include "rcl/visibility_control.h"
74 
76 
114 rcl_ret_t
115 rcl_init(int argc, char ** argv, rcl_allocator_t allocator);
116 
118 
149 rcl_ret_t
150 rcl_shutdown(void);
151 
153 
169 uint64_t
170 rcl_get_instance_id(void);
171 
173 
184 bool
185 rcl_ok(void);
186 
187 #if __cplusplus
188 }
189 #endif
190 
191 #endif // RCL__RCL_H_
rmw_ret_t rcl_ret_t
Definition: types.h:20
rcl_ret_t rcl_shutdown(void)
Signal global shutdown of rcl.
uint64_t rcl_get_instance_id(void)
Returns an uint64_t number that is unique for the latest rcl_init call.
#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
bool rcl_ok(void)
Return true if rcl is currently initialized, otherwise false.
Encapsulation of an allocator.
Definition: allocator.h:40
rcl_ret_t rcl_init(int argc, char **argv, rcl_allocator_t allocator)
Global initialization of rcl.