Ignition Transport

API Reference

4.0.0
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 IGN_TRANSPORT_SUBSCRIBEOPTIONS_HH_
19#define IGN_TRANSPORT_SUBSCRIBEOPTIONS_HH_
20
21#include <cstdint>
22#include <memory>
23
24#include "ignition/transport/Export.hh"
25
26namespace ignition
27{
28 namespace transport
29 {
30 class SubscribeOptionsPrivate;
31
35 class IGNITION_TRANSPORT_VISIBLE SubscribeOptions
36 {
39
42 public: SubscribeOptions(const SubscribeOptions &_otherSubscribeOpts);
43
46
51 public: bool Throttled() const;
52
58 public: void SetMsgsPerSec(const uint64_t _newMsgsPerSec);
59
63 public: uint64_t MsgsPerSec() const;
64
68 };
69 }
70}
71#endif
A class to provide different options for a subscription.
Definition SubscribeOptions.hh:36
SubscribeOptions(const SubscribeOptions &_otherSubscribeOpts)
Copy constructor.
std::unique_ptr< SubscribeOptionsPrivate > dataPtr
Definition SubscribeOptions.hh:67
void SetMsgsPerSec(const uint64_t _newMsgsPerSec)
Set the maximum number of messages per second received per topic. Note that we calculate the minimum ...
bool Throttled() const
Whether the subscription has been throttled.
uint64_t MsgsPerSec() const
Get the maximum number of messages per seconds received per topic.
Definition AdvertiseOptions.hh:28