CPP Client - Async call for getting broker side consumer stats

pulsar-client-cpp/include/pulsar/BrokerConsumerStats.h

@@ -0,0 +1,86 @@
+/**
+ * Copyright 2016 Yahoo Inc.
+ *
+ * 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 PULSAR_CPP_BROKERCONSUMERSTATS_H
+#define PULSAR_CPP_BROKERCONSUMERSTATS_H
+
+#include <boost/date_time/posix_time/ptime.hpp>
+#include <string.h>
+#include <iostream>
+#include <pulsar/Result.h>
+#include <boost/function.hpp>
+#include <pulsar/ConsumerType.h>
+
+namespace pulsar {
+class BrokerConsumerStatsImplBase;
+
+/* @note: isValid() or getXXX() methods are not allowed on an invalid BrokerConsumerStats */
+class BrokerConsumerStats {
+ private:
+    boost::shared_ptr<BrokerConsumerStatsImplBase> impl_;
+ public:
+    explicit BrokerConsumerStats(boost::shared_ptr<BrokerConsumerStatsImplBase> impl);
+
+    BrokerConsumerStats();
+
+    /** Returns true if the Stats are still valid **/
+    virtual bool isValid() const;
+
+    /** Returns the rate of messages delivered to the consumer. msg/s */
+    virtual double getMsgRateOut() const;
+
+    /** Returns the throughput delivered to the consumer. bytes/s */
+    virtual double getMsgThroughputOut() const;
+
+    /** Returns the rate of messages redelivered by this consumer. msg/s */
+    virtual double getMsgRateRedeliver() const;
+
+    /** Returns the Name of the consumer */
+    virtual const std::string getConsumerName() const;
+
+    /** Returns the Number of available message permits for the consumer */
+    virtual uint64_t getAvailablePermits() const;
+
+    /** Returns the Number of unacknowledged messages for the consumer */
+    virtual uint64_t getUnackedMessages() const;
+
+    /** Returns true if the consumer is blocked due to unacked messages.  */
+    virtual bool isBlockedConsumerOnUnackedMsgs() const;
+
+    /** Returns the Address of this consumer */
+    virtual const std::string getAddress() const;
+
+    /** Returns the Timestamp of connection */
+    virtual const std::string getConnectedSince() const;
+
+    /** Returns Whether this subscription is Exclusive or Shared or Failover */
+    virtual const ConsumerType getType() const;
+
+    /** Returns the rate of messages expired on this subscription. msg/s */
+    virtual double getMsgRateExpired() const;
+
+    /** Returns the Number of messages in the subscription backlog */
+    virtual uint64_t getMsgBacklog() const;
+
+    /** @deprecated */
+    boost::shared_ptr<BrokerConsumerStatsImplBase> getImpl() const;
+
+    friend std::ostream& operator<<(std::ostream &os, const BrokerConsumerStats &obj);
+};
+typedef boost::function<void(Result result, BrokerConsumerStats brokerConsumerStats)> BrokerConsumerStatsCallback;
+
+}
+#endif //PULSAR_CPP_BROKERCONSUMERSTATS_H

pulsar-client-cpp/include/pulsar/Consumer.h

@@ -23,6 +23,8 @@
 #include <pulsar/Result.h>
 #include <boost/date_time/posix_time/ptime.hpp>
 #include <iostream>
+#include <pulsar/ConsumerType.h>
+#include <pulsar/BrokerConsumerStats.h>
 #pragma GCC visibility push(default)
 
 class PulsarFriend;
@@ -37,80 +39,6 @@ typedef boost::function<void(Result result)> ResultCallback;
 /// Callback definition for MessageListener
 typedef boost::function<void(Consumer consumer, const Message& msg)> MessageListener;
 
-enum ConsumerType {
-    /**
-     * There can be only 1 consumer on the same topic with the same consumerName
-     */
-    ConsumerExclusive,
-
-    /**
-     * Multiple consumers will be able to use the same consumerName and the messages
-     *  will be dispatched according to a round-robin rotation between the connected consumers
-     */
-    ConsumerShared,
-
-    /** Only one consumer is active on the subscription; Subscription can have N consumers
-     *  connected one of which will get promoted to master if the current master becomes inactive
-     */
-
-    ConsumerFailover
-};
-
-class BrokerConsumerStats {
- private:
-    /*
-     * validTillInMs_ - Stats will be valid till this time.
-     */
-    boost::posix_time::ptime validTill_;
- public:
-    BrokerConsumerStats();
-    BrokerConsumerStats(boost::posix_time::ptime& validTill, double msgRateOut, double msgThroughputOut,
-                            double msgRateRedeliver, std::string consumerName, int availablePermits,
-                            int unackedMessages, bool blockedConsumerOnUnackedMsgs, std::string address,
-                            std::string connectedSince, std::string type, double msgRateExpired, long msgBacklog);
-
-    /** Returns true if the Message is Expired **/
-    bool isValid() const;
-
-    /** Total rate of messages delivered to the consumer. msg/s */
-    double msgRateOut_;
-
-    /** Total throughput delivered to the consumer. bytes/s */
-    double msgThroughputOut_;
-
-    /** Total rate of messages redelivered by this consumer. msg/s */
-    double msgRateRedeliver_;
-
-    /** Name of the consumer */
-    std::string consumerName_;
-
-    /** Number of available message permits for the consumer */
-    int availablePermits_;
-
-    /** Number of unacknowledged messages for the consumer */
-    int unackedMessages_;
-
-    /** Flag to verify if consumer is blocked due to reaching threshold of unacked messages */
-    bool blockedConsumerOnUnackedMsgs_;
-
-    /** Address of this consumer */
-    std::string address_;
-
-    /** Timestamp of connection */
-    std::string connectedSince_;
-
-    /// Whether this subscription is Exclusive or Shared or Failover
-    std::string type_;
-
-    /// Total rate of messages expired on this subscription. msg/s
-    double msgRateExpired_;
-
-    /// Number of messages in the subscription backlog
-    long msgBacklog_;
-
-    friend std::ostream& operator<<(std::ostream& os, const BrokerConsumerStats& obj);
-};
-
 /**
  * Class specifying the configuration of a consumer.
  */
@@ -182,6 +110,18 @@ class ConsumerConfiguration {
      * @return the configured timeout in milliseconds for unacked messages.
      */
     long getUnAckedMessagesTimeoutMs() const;
+
+    /**
+     * Set the time duration for which the broker side consumer stats will be cached in the client.
+     * @param cacheTimeInMs in milliseconds
+     */
+    void setBrokerConsumerStatsCacheTimeInMs(const long cacheTimeInMs);
+
+    /**
+     * @return the configured timeout in milliseconds caching BrokerConsumerStats.
+     */
+    long getBrokerConsumerStatsCacheTimeInMs() const;
+
  private:
     struct Impl;
     boost::shared_ptr<Impl> impl_;
@@ -347,12 +287,21 @@ class Consumer {
      * still valid.
      *
      * @param brokerConsumerStats - if the function returns ResultOk, this object will contain consumer stats
-     * @param partitionIndex - optional parameter which is to be populated only if the topic is partitioned.
      *
      * @note This is a blocking call with timeout of thirty seconds.
      */
-    Result getConsumerStats(BrokerConsumerStats& brokerConsumerStats, int partitionIndex = -1);
+    Result getBrokerConsumerStats(BrokerConsumerStats& brokerConsumerStats);
 
+    /**
+    * Asynchronous call to gets Consumer Stats from broker.
+    * The stats are cached for 30 seconds, if a call is made before the stats returned by the previous call expires
+    * then cached data will be returned. BrokerConsumerStats::isValid() function can be used to check if the stats are
+    * still valid.
+    *
+    * @param callback - callback function to get the brokerConsumerStats,
+    *                   if result is ResultOk then the brokerConsumerStats will be populated
+    */
+    void getBrokerConsumerStatsAsync(BrokerConsumerStatsCallback callback);
 private:
     typedef boost::shared_ptr<ConsumerImplBase> ConsumerImplBasePtr;
     friend class PulsarFriend;

pulsar-client-cpp/include/pulsar/ConsumerType.h

@@ -0,0 +1,40 @@
+/**
+ * Copyright 2016 Yahoo Inc.
+ *
+ * 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 PULSAR_CPP_CONSUMERTYPE_H
+#define PULSAR_CPP_CONSUMERTYPE_H
+
+namespace pulsar {
+    enum ConsumerType {
+        /**
+         * There can be only 1 consumer on the same topic with the same consumerName
+         */
+        ConsumerExclusive,
+
+        /**
+         * Multiple consumers will be able to use the same consumerName and the messages
+         *  will be dispatched according to a round-robin rotation between the connected consumers
+         */
+        ConsumerShared,
+
+        /** Only one consumer is active on the subscription; Subscription can have N consumers
+         *  connected one of which will get promoted to master if the current master becomes inactive
+         */
+        ConsumerFailover
+    };
+}
+
+#endif //PULSAR_CPP_CONSUMERTYPE_H

pulsar-client-cpp/lib/BrokerConsumerStats.cc

@@ -0,0 +1,99 @@
+/**
+ * Copyright 2016 Yahoo Inc.
+ *
+ * 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.
+ */
+
+#include <pulsar/BrokerConsumerStats.h>
+#include <lib/BrokerConsumerStatsImplBase.h>
+
+namespace pulsar {
+BrokerConsumerStats::BrokerConsumerStats(boost::shared_ptr<BrokerConsumerStatsImplBase> impl)
+        : impl_(impl) {
+}
+
+BrokerConsumerStats::BrokerConsumerStats() {
+}
+
+boost::shared_ptr<BrokerConsumerStatsImplBase> BrokerConsumerStats::getImpl() const {
+    return impl_;
+}
+
+bool BrokerConsumerStats::isValid() const {
+    return impl_->isValid();
+}
+
+std::ostream& operator<<(std::ostream &os, const BrokerConsumerStats& obj) {
+    os << "\nBrokerConsumerStats [" << "validTill_ = " << obj.isValid() << ", msgRateOut_ = "
+       << obj.getMsgRateOut() << ", msgThroughputOut_ = " << obj.getMsgThroughputOut()
+       << ", msgRateRedeliver_ = " << obj.getMsgRateRedeliver() << ", consumerName_ = "
+       << obj.getConsumerName() << ", availablePermits_ = " << obj.getAvailablePermits()
+       << ", unackedMessages_ = " << obj.getUnackedMessages()
+       << ", blockedConsumerOnUnackedMsgs_ = " << obj.isBlockedConsumerOnUnackedMsgs()
+       << ", address_ = " << obj.getAddress() << ", connectedSince_ = " << obj.getConnectedSince()
+       << ", type_ = " << obj.getType() << ", msgRateExpired_ = " << obj.getMsgRateExpired()
+       << ", msgBacklog_ = " << obj.getMsgBacklog() << "]";
+    return os;
+}
+
+double BrokerConsumerStats::getMsgRateOut() const {
+    if (impl_) {
+        return impl_->getMsgRateOut();
+    }
+    return 0;
+}
+
+double BrokerConsumerStats::getMsgThroughputOut() const {
+    return impl_->getMsgThroughputOut();
+}
+
+double BrokerConsumerStats::getMsgRateRedeliver() const {
+    return impl_->getMsgRateRedeliver();
+}
+
+const std::string BrokerConsumerStats::getConsumerName() const {
+    return impl_->getConsumerName();
+}
+
+uint64_t BrokerConsumerStats::getAvailablePermits() const {
+    return impl_->getAvailablePermits();
+}
+
+uint64_t BrokerConsumerStats::getUnackedMessages() const {
+    return impl_->getUnackedMessages();
+}
+
+bool BrokerConsumerStats::isBlockedConsumerOnUnackedMsgs() const {
+    return impl_->isBlockedConsumerOnUnackedMsgs();
+}
+
+const std::string BrokerConsumerStats::getAddress() const {
+    return impl_->getAddress();
+}
+
+const std::string BrokerConsumerStats::getConnectedSince() const {
+    return impl_->getConnectedSince();
+}
+
+const ConsumerType BrokerConsumerStats::getType() const {
+    return impl_->getType();
+}
+
+double BrokerConsumerStats::getMsgRateExpired() const {
+    return impl_->getMsgRateExpired();
+}
+
+uint64_t BrokerConsumerStats::getMsgBacklog() const {
+    return impl_->getMsgBacklog();
+}
+}