pulsar-client-cpp
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
pulsar::BrokerConsumerStats Class Reference

Public Member Functions

 BrokerConsumerStats (std::shared_ptr< BrokerConsumerStatsImplBase > impl)
 
virtual bool isValid () const
 
virtual double getMsgRateOut () const
 
virtual double getMsgThroughputOut () const
 
virtual double getMsgRateRedeliver () const
 
virtual const std::string getConsumerName () const
 
virtual uint64_t getAvailablePermits () const
 
virtual uint64_t getUnackedMessages () const
 
virtual bool isBlockedConsumerOnUnackedMsgs () const
 
virtual const std::string getAddress () const
 
virtual const std::string getConnectedSince () const
 
virtual const ConsumerType getType () const
 
virtual double getMsgRateExpired () const
 
virtual uint64_t getMsgBacklog () const
 
std::shared_ptr< BrokerConsumerStatsImplBase > getImpl () const
 

Friends

class PulsarWrapper
 
PULSAR_PUBLIC std::ostream & operator<< (std::ostream &os, const BrokerConsumerStats &obj)
 

Member Function Documentation

◆ getAddress()

virtual const std::string pulsar::BrokerConsumerStats::getAddress ( ) const
virtual

Returns the Address of this consumer

◆ getAvailablePermits()

virtual uint64_t pulsar::BrokerConsumerStats::getAvailablePermits ( ) const
virtual

Returns the Number of available message permits for the consumer

◆ getConnectedSince()

virtual const std::string pulsar::BrokerConsumerStats::getConnectedSince ( ) const
virtual

Returns the Timestamp of connection

◆ getConsumerName()

virtual const std::string pulsar::BrokerConsumerStats::getConsumerName ( ) const
virtual

Returns the Name of the consumer

◆ getImpl()

std::shared_ptr< BrokerConsumerStatsImplBase > pulsar::BrokerConsumerStats::getImpl ( ) const

◆ getMsgBacklog()

virtual uint64_t pulsar::BrokerConsumerStats::getMsgBacklog ( ) const
virtual

Returns the Number of messages in the subscription backlog

◆ getMsgRateExpired()

virtual double pulsar::BrokerConsumerStats::getMsgRateExpired ( ) const
virtual

Returns the rate of messages expired on this subscription. msg/s

◆ getMsgRateOut()

virtual double pulsar::BrokerConsumerStats::getMsgRateOut ( ) const
virtual

Returns the rate of messages delivered to the consumer. msg/s

◆ getMsgRateRedeliver()

virtual double pulsar::BrokerConsumerStats::getMsgRateRedeliver ( ) const
virtual

Returns the rate of messages redelivered by this consumer. msg/s

◆ getMsgThroughputOut()

virtual double pulsar::BrokerConsumerStats::getMsgThroughputOut ( ) const
virtual

Returns the throughput delivered to the consumer. bytes/s

◆ getType()

virtual const ConsumerType pulsar::BrokerConsumerStats::getType ( ) const
virtual

Returns Whether this subscription is Exclusive or Shared or Failover

◆ getUnackedMessages()

virtual uint64_t pulsar::BrokerConsumerStats::getUnackedMessages ( ) const
virtual

Returns the Number of unacknowledged messages for the consumer

◆ isBlockedConsumerOnUnackedMsgs()

virtual bool pulsar::BrokerConsumerStats::isBlockedConsumerOnUnackedMsgs ( ) const
virtual

Returns true if the consumer is blocked due to unacked messages.

◆ isValid()

virtual bool pulsar::BrokerConsumerStats::isValid ( ) const
virtual

Returns true if the Stats are still valid


The documentation for this class was generated from the following file: