Gazebo Transport

API Reference

8.5.0
gz/transport/SubscribeOptions.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 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_SUBSCRIBEOPTIONS_HH_
19 #define GZ_TRANSPORT_SUBSCRIBEOPTIONS_HH_
20 
21 #include <cstdint>
22 #include <memory>
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  //
34  class SubscribeOptionsPrivate;
35 
39  class IGNITION_TRANSPORT_VISIBLE SubscribeOptions
40  {
42  public: SubscribeOptions();
43 
46  public: SubscribeOptions(const SubscribeOptions &_otherSubscribeOpts);
47 
49  public: ~SubscribeOptions();
50 
55  public: bool Throttled() const;
56 
62  public: void SetMsgsPerSec(const uint64_t _newMsgsPerSec);
63 
67  public: uint64_t MsgsPerSec() const;
68 
69 #ifdef _WIN32
70 // Disable warning C4251 which is triggered by
71 // std::unique_ptr
72 #pragma warning(push)
73 #pragma warning(disable: 4251)
74 #endif
78 #ifdef _WIN32
79 #pragma warning(pop)
80 #endif
81  };
82  }
83  }
84 }
85 #endif
Definition: gz/transport/AdvertiseOptions.hh:28
std::unique_ptr< SubscribeOptionsPrivate > dataPtr
Definition: gz/transport/SubscribeOptions.hh:77
void SetMsgsPerSec(const uint64_t _newMsgsPerSec)
Set the maximum number of messages per second received per topic. Note that we calculate the minimum ...
A class to provide different options for a subscription.
Definition: gz/transport/SubscribeOptions.hh:39
uint64_t MsgsPerSec() const
Get the maximum number of messages per seconds received per topic.
bool Throttled() const
Whether the subscription has been throttled.