rcl
master
C API providing common ROS client library functionality.
include
rcl
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
16
17
#ifndef RCL__INIT_H_
18
#define RCL__INIT_H_
19
20
#ifdef __cplusplus
21
extern
"C"
22
{
23
#endif
24
25
#include "
rcl/allocator.h
"
26
#include "
rcl/context.h
"
27
#include "
rcl/init_options.h
"
28
#include "rcl/macros.h"
29
#include "
rcl/types.h
"
30
#include "rcl/visibility_control.h"
31
33
78
RCL_PUBLIC
79
RCL_WARN_UNUSED
80
rcl_ret_t
81
rcl_init
(
82
int
argc,
83
char
const
*
const
* argv,
84
const
rcl_init_options_t
* options,
85
rcl_context_t
* context);
86
88
112
RCL_PUBLIC
113
RCL_WARN_UNUSED
114
rcl_ret_t
115
rcl_shutdown
(
rcl_context_t
* context);
116
117
#ifdef __cplusplus
118
}
119
#endif
120
121
#endif // RCL__INIT_H_
types.h
rcl_ret_t
rmw_ret_t rcl_ret_t
The type that holds an rcl return code.
Definition:
types.h:23
rcl_init
rcl_ret_t rcl_init(int argc, char const *const *argv, const rcl_init_options_t *options, rcl_context_t *context)
Initialization of rcl.
rcl_init_options_t
Encapsulation of init options and implementation defined init options.
Definition:
init_options.h:35
rcl_shutdown
rcl_ret_t rcl_shutdown(rcl_context_t *context)
Shutdown a given rcl context.
init_options.h
allocator.h
rcl_context_t
Encapsulates the non-global state of an init/shutdown cycle.
Definition:
context.h:113
context.h
Generated by
1.8.17