rcl  master
C API providing common ROS client library functionality.
init.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 
15 #ifndef RCL__INIT_H_
16 #define RCL__INIT_H_
17 
18 #ifdef __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include "rcl/allocator.h"
24 #include "rcl/context.h"
25 #include "rcl/init_options.h"
26 #include "rcl/macros.h"
27 #include "rcl/types.h"
28 #include "rcl/visibility_control.h"
29 
31 
78 rcl_init(
79  int argc,
80  char const * const * argv,
81  const rcl_init_options_t * options,
82  rcl_context_t * context);
83 
85 
110 rcl_ret_t
111 rcl_shutdown(rcl_context_t * context);
112 
113 #ifdef __cplusplus
114 }
115 #endif
116 
117 #endif // RCL__INIT_H_
rmw_ret_t rcl_ret_t
Definition: types.h:20
rcl_ret_t rcl_shutdown(rcl_context_t *context)
Shutdown a given rcl context.
rcl_ret_t rcl_init(int argc, char const *const *argv, const rcl_init_options_t *options, rcl_context_t *context)
Initialization of rcl.
#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
Encapsulates the non-global state of an init/shutdown cycle.
Definition: context.h:108