SubscribeOptions.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 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_SUBSCRIBEOPTIONS_HH_
#define GZ_TRANSPORT_SUBSCRIBEOPTIONS_HH_
 
#include <cstdint>
#include <memory>
 
#include "gz/transport/config.hh"
#include "gz/transport/Export.hh"
 
namespace gz::transport
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_TRANSPORT_VERSION_NAMESPACE {
  //
  class SubscribeOptionsPrivate;
 
  class GZ_TRANSPORT_VISIBLE SubscribeOptions
  {
    public: SubscribeOptions();
 
    public: SubscribeOptions(const SubscribeOptions &_otherSubscribeOpts);
 
    public: ~SubscribeOptions();
 
    public: bool Throttled() const;
 
    public: void SetMsgsPerSec(const uint64_t _newMsgsPerSec);
 
    public: uint64_t MsgsPerSec() const;
 
    public: void SetIgnoreLocalMessages(bool _ignore);
 
    public: bool IgnoreLocalMessages() const;
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    protected: std::unique_ptr<SubscribeOptionsPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
  };
  }
}
#endif