rmw  master
C API providing a middleware abstraction layer which is used to implement the rest of ROS.
topic_endpoint_info_array.h
Go to the documentation of this file.
1 // Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
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 RMW__TOPIC_ENDPOINT_INFO_ARRAY_H_
16 #define RMW__TOPIC_ENDPOINT_INFO_ARRAY_H_
17 
18 #ifdef __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include "rcutils/allocator.h"
25 #include "rmw/visibility_control.h"
26 
29 {
31  size_t size;
35 
41 
43 
57  rmw_topic_endpoint_info_array_t * topic_endpoint_info_array);
58 
60 
84  rmw_topic_endpoint_info_array_t * topic_endpoint_info_array,
85  size_t size,
86  rcutils_allocator_t * allocator);
87 
89 
106 rmw_ret_t
108  rmw_topic_endpoint_info_array_t * topic_endpoint_info_array,
109  rcutils_allocator_t * allocator);
110 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif // RMW__TOPIC_ENDPOINT_INFO_ARRAY_H_
RMW_PUBLIC
#define RMW_PUBLIC
Definition: visibility_control.h:48
rmw_get_zero_initialized_topic_endpoint_info_array
rmw_topic_endpoint_info_array_t rmw_get_zero_initialized_topic_endpoint_info_array(void)
Return a rmw_topic_endpoint_info_array_t struct with members initialized to NULL.
rmw_topic_endpoint_info_array_t::size
size_t size
Size of the array.
Definition: topic_endpoint_info_array.h:31
RMW_PUBLIC_TYPE
RMW_PUBLIC_TYPE
Type mapping of rcutils log severity types to rmw specific types.
Definition: types.h:499
rmw_topic_endpoint_info_array_t
struct RMW_PUBLIC_TYPE rmw_topic_endpoint_info_array_t rmw_topic_endpoint_info_array_t
Array of rmw_topic_endpoint_info_t.
RMW_WARN_UNUSED
#define RMW_WARN_UNUSED
Indicate that a variable is not used, and prevent compiler from issuing warnings.
Definition: macros.h:24
rmw_topic_endpoint_info_array_init_with_size
rmw_ret_t rmw_topic_endpoint_info_array_init_with_size(rmw_topic_endpoint_info_array_t *topic_endpoint_info_array, size_t size, rcutils_allocator_t *allocator)
Initialize the info_array member inside rmw_topic_endpoint_info_array_t with the given size.
allocator.h
rmw_ret_t
int32_t rmw_ret_t
Return code for rmw functions.
Definition: ret_types.h:26
visibility_control.h
rcutils_allocator_t
rmw_topic_endpoint_info_t
Definition: topic_endpoint_info.h:29
rmw_topic_endpoint_info_array_t
Array of rmw_topic_endpoint_info_t.
Definition: topic_endpoint_info_array.h:28
rmw_topic_endpoint_info_array_check_zero
rmw_ret_t rmw_topic_endpoint_info_array_check_zero(rmw_topic_endpoint_info_array_t *topic_endpoint_info_array)
Check that a rmw_topic_endpoint_info_array_t struct is zero initialized.
rmw_topic_endpoint_info_array_fini
rmw_ret_t rmw_topic_endpoint_info_array_fini(rmw_topic_endpoint_info_array_t *topic_endpoint_info_array, rcutils_allocator_t *allocator)
Finalize a rmw_topic_endpoint_info_array_t object.
rmw_topic_endpoint_info_array_t::info_array
rmw_topic_endpoint_info_t * info_array
Pointer representing an array of rmw_topic_endpoint_info_t.
Definition: topic_endpoint_info_array.h:33
topic_endpoint_info.h