Gazebo Transport

API Reference

8.5.0
gz/transport/TopicUtils.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 
18 #ifndef GZ_TRANSPORT_TOPICUTILS_HH_
19 #define GZ_TRANSPORT_TOPICUTILS_HH_
20 
21 #include <cstdint>
22 #include <string>
23 
24 #include "gz/transport/config.hh"
25 #include "gz/transport/Export.hh"
26 
27 namespace ignition
28 {
29  namespace transport
30  {
31  // Inline bracket to help doxygen filtering.
32  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
33  //
36  class IGNITION_TRANSPORT_VISIBLE TopicUtils
37  {
44  public: static bool IsValidNamespace(const std::string &_ns);
45 
53  public: static bool IsValidPartition(const std::string &_partition);
54 
64  public: static bool IsValidTopic(const std::string &_topic);
65 
102  public: static bool FullyQualifiedName(const std::string &_partition,
103  const std::string &_ns,
104  const std::string &_topic,
105  std::string &_name);
106 
127  public: static bool DecomposeFullyQualifiedTopic(
128  const std::string &_fullyQualifiedName,
129  std::string &_partition,
130  std::string &_namespaceAndTopic);
131 
138  public: static std::string AsValidTopic(const std::string &_topic);
139 
143  public: static const uint16_t kMaxNameLength = 65535;
144  };
145  }
146  }
147 }
148 
149 #endif
Definition: gz/transport/AdvertiseOptions.hh:28
STL class.
static bool IsValidNamespace(const std::string &_ns)
Determines if a namespace is valid. A namespace's length must not exceed kMaxNameLength....
static std::string AsValidTopic(const std::string &_topic)
Convert a topic name to a valid topic. The input topic is modified by:
static bool FullyQualifiedName(const std::string &_partition, const std::string &_ns, const std::string &_topic, std::string &_name)
Get the full topic path given a namespace and a topic name. A fully qualified topic name's length mus...
static bool IsValidTopic(const std::string &_topic)
Determines if a topic name is valid. A topic name is any non-empty alphanumeric string....
static bool DecomposeFullyQualifiedTopic(const std::string &_fullyQualifiedName, std::string &_partition, std::string &_namespaceAndTopic)
Decompose a fully qualified topic name into its partition and topic strings. Note that if the topic i...
static const uint16_t kMaxNameLength
The kMaxNameLength specifies the maximum number of characters allowed in a namespace,...
Definition: gz/transport/TopicUtils.hh:143
static bool IsValidPartition(const std::string &_partition)
Determines if a partition is valid. The same rules to validate a topic name applies to a partition wi...
This class provides different utilities related with topics.
Definition: gz/transport/TopicUtils.hh:36