rmw  master
C API providing a middleware abstraction layer which is used to implement the rest of ROS.
validate_full_topic_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_FULL_TOPIC_NAME_H_
16 #define RMW__VALIDATE_FULL_TOPIC_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_TOPIC_VALID 0
27 #define RMW_TOPIC_INVALID_IS_EMPTY_STRING 1
28 #define RMW_TOPIC_INVALID_NOT_ABSOLUTE 2
29 #define RMW_TOPIC_INVALID_ENDS_WITH_FORWARD_SLASH 3
30 #define RMW_TOPIC_INVALID_CONTAINS_UNALLOWED_CHARACTERS 4
31 #define RMW_TOPIC_INVALID_CONTAINS_REPEATED_FORWARD_SLASH 5
32 #define RMW_TOPIC_INVALID_NAME_TOKEN_STARTS_WITH_NUMBER 6
33 #define RMW_TOPIC_INVALID_TOO_LONG 7
34 
35 #define RMW_TOPIC_MAX_NAME_LENGTH 255U /* impl constraint */ - 8U /* reserved for prefixes */
36 
38 
88  const char * topic_name,
89  int * validation_result,
90  size_t * invalid_index);
91 
93 
101 rmw_ret_t
103  const char * topic_name,
104  size_t topic_name_length,
105  int * validation_result,
106  size_t * invalid_index);
107 
111 const char *
112 rmw_full_topic_name_validation_result_string(int validation_result);
113 
114 #ifdef __cplusplus
115 }
116 #endif
117 
118 #endif // RMW__VALIDATE_FULL_TOPIC_NAME_H_
rmw_full_topic_name_validation_result_string
const char * rmw_full_topic_name_validation_result_string(int validation_result)
Return a validation result description, or NULL if unknown or RMW_TOPIC_VALID.
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_full_topic_name_with_size
rmw_ret_t rmw_validate_full_topic_name_with_size(const char *topic_name, size_t topic_name_length, int *validation_result, size_t *invalid_index)
Deterimine if a given topic name is valid.
rmw_ret_t
int32_t rmw_ret_t
Return code for rmw functions.
Definition: ret_types.h:26
rmw_validate_full_topic_name
rmw_ret_t rmw_validate_full_topic_name(const char *topic_name, int *validation_result, size_t *invalid_index)
Determine if a given fully qualified topic name is valid.