rmw  master
C API providing a middleware abstraction layer which is used to implement the rest of ROS.
validate_node_name.h
Go to the documentation of this file.
1 // Copyright 2017 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 RMW__VALIDATE_NODE_NAME_H_
16 #define RMW__VALIDATE_NODE_NAME_H_
17 
18 #ifdef __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include "rmw/macros.h"
24 #include "rmw/types.h"
25 
26 #define RMW_NODE_NAME_VALID 0
27 #define RMW_NODE_NAME_INVALID_IS_EMPTY_STRING 1
28 #define RMW_NODE_NAME_INVALID_CONTAINS_UNALLOWED_CHARACTERS 2
29 #define RMW_NODE_NAME_INVALID_STARTS_WITH_NUMBER 3
30 #define RMW_NODE_NAME_INVALID_TOO_LONG 4
31 
32 #define RMW_NODE_NAME_MAX_NAME_LENGTH 255 /* arbitrary constraint */
33 
35 
82  const char * node_name,
83  int * validation_result,
84  size_t * invalid_index);
85 
87 
97  const char * node_name,
98  size_t node_name_length,
99  int * validation_result,
100  size_t * invalid_index);
101 
105 const char *
106 rmw_node_name_validation_result_string(int validation_result);
107 
108 #ifdef __cplusplus
109 }
110 #endif
111 
112 #endif // RMW__VALIDATE_NODE_NAME_H_
RMW_PUBLIC
#define RMW_PUBLIC
Definition: visibility_control.h:48
types.h
macros.h
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_validate_node_name_with_size
rmw_ret_t rmw_validate_node_name_with_size(const char *node_name, size_t node_name_length, int *validation_result, size_t *invalid_index)
Deterimine if a given node name is valid.
rmw_node_name_validation_result_string
const char * rmw_node_name_validation_result_string(int validation_result)
Return a validation result description, or NULL if unknown or RMW_NODE_NAME_VALID.
rmw_ret_t
int32_t rmw_ret_t
Return code for rmw functions.
Definition: ret_types.h:26
rmw_validate_node_name
rmw_ret_t rmw_validate_node_name(const char *node_name, int *validation_result, size_t *invalid_index)
Determine if a node name is valid.