ROS 2 rclcpp + rcl - jazzy  jazzy
ROS 2 C++ Client Library with ROS Client Library
discovery_options.h
Go to the documentation of this file.
1 // Copyright 2022 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__DISCOVERY_OPTIONS_H_
18 #define RCL__DISCOVERY_OPTIONS_H_
19 
20 #ifdef __cplusplus
21 extern "C"
22 {
23 #endif
24 
25 #include "rcl/types.h"
26 #include "rcl/visibility_control.h"
27 
28 #include "rcutils/allocator.h"
29 
30 #include "rmw/discovery_options.h"
31 
33 
60 RCL_PUBLIC
62 rcl_get_automatic_discovery_range(rmw_discovery_options_t * discovery_options);
63 
65 
69 RCL_PUBLIC
70 const char *
71 rcl_automatic_discovery_range_to_string(rmw_automatic_discovery_range_t automatic_discovery_range);
72 
74 
99 RCL_PUBLIC
100 rcl_ret_t
102  rmw_discovery_options_t * discovery_options,
103  rcutils_allocator_t * allocator);
104 
105 #ifdef __cplusplus
106 }
107 #endif
108 
109 #endif // RCL__DISCOVERY_OPTIONS_H_
RCL_PUBLIC rcl_ret_t rcl_get_discovery_static_peers(rmw_discovery_options_t *discovery_options, rcutils_allocator_t *allocator)
Determine how the user wishes to discover other ROS nodes via statically-configured peers.
RCL_PUBLIC const char * rcl_automatic_discovery_range_to_string(rmw_automatic_discovery_range_t automatic_discovery_range)
Convert the automatic discovery range value to a string for easy printing.
RCL_PUBLIC rcl_ret_t rcl_get_automatic_discovery_range(rmw_discovery_options_t *discovery_options)
Determine how the user wishes to discover other ROS nodes automatically.
rmw_ret_t rcl_ret_t
The type that holds an rcl return code.
Definition: types.h:24