AdvertiseOptions.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 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 IGN_TRANSPORT_ADVERTISEOPTIONS_HH_
#define IGN_TRANSPORT_ADVERTISEOPTIONS_HH_

#include <cstdint>
#include <iostream>
#include <memory>

#include "ignition/transport/config.hh"
#include "ignition/transport/Export.hh"

namespace ignition
{
  namespace transport
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
    //
    // Forward declarations.
    class AdvertiseOptionsPrivate;
    class AdvertiseMessageOptionsPrivate;
    class AdvertiseServiceOptionsPrivate;

    enum class Scope_t
    {
      PROCESS,
      HOST,
      ALL
    };

    class IGNITION_TRANSPORT_VISIBLE AdvertiseOptions
    {
      public: AdvertiseOptions();

      public: AdvertiseOptions(const AdvertiseOptions &_other);

      public: virtual ~AdvertiseOptions();

      public: AdvertiseOptions &operator=(const AdvertiseOptions &_other);

      public: bool operator==(const AdvertiseOptions &_other) const;

      public: bool operator!=(const AdvertiseOptions &_other) const;

      public: friend std::ostream &operator<<(std::ostream &_out,
                                              const AdvertiseOptions &_other)
      {
        _out << "Advertise options:\n"
             << "\tScope: ";
        if (_other.Scope() == Scope_t::PROCESS)
          _out << "Process" << std::endl;
        else if (_other.Scope() == Scope_t::HOST)
          _out << "Host" << std::endl;
        else
          _out << "All" << std::endl;
        return _out;
      }

      public: const Scope_t &Scope() const;

      public: void SetScope(const Scope_t &_scope);

      public: size_t IGN_DEPRECATED(8) Pack(char *_buffer) const;

      public: size_t IGN_DEPRECATED(8) Unpack(const char *_buffer);

      public: size_t IGN_DEPRECATED(8) MsgLength() const;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<AdvertiseOptionsPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };

    class IGNITION_TRANSPORT_VISIBLE AdvertiseMessageOptions
      : public AdvertiseOptions
    {
      public: AdvertiseMessageOptions();

      public: AdvertiseMessageOptions(const AdvertiseMessageOptions &_other);

      public: virtual ~AdvertiseMessageOptions();

      public: AdvertiseMessageOptions &operator=(
        const AdvertiseMessageOptions &_other);

      public: bool operator==(const AdvertiseMessageOptions &_other) const;

      public: bool operator!=(const AdvertiseMessageOptions &_other) const;

      public: friend std::ostream &operator<<(std::ostream &_out,
                                          const AdvertiseMessageOptions &_other)
      {
        _out << static_cast<AdvertiseOptions>(_other);
        if (_other.Throttled())
        {
          _out << "\tThrottled? Yes" << std::endl;
          _out << "\tRate: " << _other.MsgsPerSec() << " msgs/sec" << std::endl;
        }
        else
          _out << "\tThrottled? No" << std::endl;

        return _out;
      }

      public: bool Throttled() const;

      public: uint64_t MsgsPerSec() const;

      public: void SetMsgsPerSec(const uint64_t _newMsgsPerSec);

      public: size_t IGN_DEPRECATED(8) Pack(char *_buffer) const;

      public: size_t IGN_DEPRECATED(8) Unpack(const char *_buffer);

      public: size_t IGN_DEPRECATED(8) MsgLength() const;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<AdvertiseMessageOptionsPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };

    class IGNITION_TRANSPORT_VISIBLE AdvertiseServiceOptions
      : public AdvertiseOptions
    {
      public: AdvertiseServiceOptions();

      public: AdvertiseServiceOptions(const AdvertiseServiceOptions &_other);

      public: virtual ~AdvertiseServiceOptions();

      public: AdvertiseServiceOptions &operator=(
        const AdvertiseServiceOptions &_other);

      public: bool operator==(const AdvertiseServiceOptions &_other) const;

      public: bool operator!=(const AdvertiseServiceOptions &_other) const;

      public: friend std::ostream &operator<<(std::ostream &_out,
                                          const AdvertiseServiceOptions &_other)
      {
        _out << static_cast<AdvertiseOptions>(_other);
        return _out;
      }

      public: size_t IGN_DEPRECATED(8) Pack(char *_buffer) const;

      public: size_t IGN_DEPRECATED(8) Unpack(const char *_buffer);

      public: size_t IGN_DEPRECATED(8) MsgLength() const;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<AdvertiseServiceOptionsPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };
    }
  }
}
#endif