gz/transport/TopicUtils.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2014 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
 
#ifndef GZ_TRANSPORT_TOPICUTILS_HH_
#define GZ_TRANSPORT_TOPICUTILS_HH_
 
#include <cstdint>
#include <string>
 
#include "gz/transport/config.hh"
#include "gz/transport/Export.hh"
 
namespace ignition
{
  namespace transport
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
    //
    class IGNITION_TRANSPORT_VISIBLE TopicUtils
    {
      public: static bool IsValidNamespace(const std::string &_ns);
 
      public: static bool IsValidPartition(const std::string &_partition);
 
      public: static bool IsValidTopic(const std::string &_topic);
 
      public: static bool FullyQualifiedName(const std::string &_partition,
                                             const std::string &_ns,
                                             const std::string &_topic,
                                             std::string &_name);
 
      public: static bool DecomposeFullyQualifiedTopic(
        const std::string &_fullyQualifiedName,
        std::string &_partition,
        std::string &_namespaceAndTopic);
 
      public: static std::string AsValidTopic(const std::string &_topic);
 
      public: static const uint16_t kMaxNameLength = 65535;
    };
    }
  }
}
 
#endif