blob: 5d30eba93f7ae6583963341318b632bc757c781d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>pulsar-client-cpp: pulsar::BrokerConsumerStats Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">pulsar-client-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacepulsar.html">pulsar</a></li><li class="navelem"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html">BrokerConsumerStats</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classpulsar_1_1_broker_consumer_stats-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pulsar::BrokerConsumerStats Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a51c0e90fdb15d60fd6c2eef61dc40f90"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51c0e90fdb15d60fd6c2eef61dc40f90"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BrokerConsumerStats</b> (boost::shared_ptr&lt; BrokerConsumerStatsImplBase &gt; impl)</td></tr>
<tr class="separator:a51c0e90fdb15d60fd6c2eef61dc40f90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab832325475970e501d0e10530696a8d1"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#ab832325475970e501d0e10530696a8d1">isValid</a> () const </td></tr>
<tr class="separator:ab832325475970e501d0e10530696a8d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3149c4040e0e8f23d7aad5fd0e6daef2"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a3149c4040e0e8f23d7aad5fd0e6daef2">getMsgRateOut</a> () const </td></tr>
<tr class="separator:a3149c4040e0e8f23d7aad5fd0e6daef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94f8a62b3c43054350e1e43d261aa24a"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a94f8a62b3c43054350e1e43d261aa24a">getMsgThroughputOut</a> () const </td></tr>
<tr class="separator:a94f8a62b3c43054350e1e43d261aa24a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16d93551fe5cc0eefb45355c364ec8fb"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a16d93551fe5cc0eefb45355c364ec8fb">getMsgRateRedeliver</a> () const </td></tr>
<tr class="separator:a16d93551fe5cc0eefb45355c364ec8fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3806cd15b0c67a7fdb9d44df5834a4c2"><td class="memItemLeft" align="right" valign="top">virtual const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a3806cd15b0c67a7fdb9d44df5834a4c2">getConsumerName</a> () const </td></tr>
<tr class="separator:a3806cd15b0c67a7fdb9d44df5834a4c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09cce823b8f5d304427ede767bc2529e"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a09cce823b8f5d304427ede767bc2529e">getAvailablePermits</a> () const </td></tr>
<tr class="separator:a09cce823b8f5d304427ede767bc2529e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9d2d4b9275bc88fc918ee49cec3a1bc"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#ad9d2d4b9275bc88fc918ee49cec3a1bc">getUnackedMessages</a> () const </td></tr>
<tr class="separator:ad9d2d4b9275bc88fc918ee49cec3a1bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fd64309f7ebc4ebf1322f3f52693aa5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a3fd64309f7ebc4ebf1322f3f52693aa5">isBlockedConsumerOnUnackedMsgs</a> () const </td></tr>
<tr class="separator:a3fd64309f7ebc4ebf1322f3f52693aa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46bdf3a845d75f888d4ae6f840a3b5ce"><td class="memItemLeft" align="right" valign="top">virtual const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a46bdf3a845d75f888d4ae6f840a3b5ce">getAddress</a> () const </td></tr>
<tr class="separator:a46bdf3a845d75f888d4ae6f840a3b5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac03b51633cb154c978c7eee445f48d96"><td class="memItemLeft" align="right" valign="top">virtual const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#ac03b51633cb154c978c7eee445f48d96">getConnectedSince</a> () const </td></tr>
<tr class="separator:ac03b51633cb154c978c7eee445f48d96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d0dfb988e6228ce4d70031a4940c3a7"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40">ConsumerType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a6d0dfb988e6228ce4d70031a4940c3a7">getType</a> () const </td></tr>
<tr class="separator:a6d0dfb988e6228ce4d70031a4940c3a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32ca24ab537319ef54d01d255a84c9bf"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a32ca24ab537319ef54d01d255a84c9bf">getMsgRateExpired</a> () const </td></tr>
<tr class="separator:a32ca24ab537319ef54d01d255a84c9bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a453c7d2e95d471d6ca3f3416bb9fc211"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#a453c7d2e95d471d6ca3f3416bb9fc211">getMsgBacklog</a> () const </td></tr>
<tr class="separator:a453c7d2e95d471d6ca3f3416bb9fc211"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab58b97edf0a420f63c3dc2ed29a05485"><td class="memItemLeft" align="right" valign="top">boost::shared_ptr&lt; BrokerConsumerStatsImplBase &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_broker_consumer_stats.html#ab58b97edf0a420f63c3dc2ed29a05485">getImpl</a> () const </td></tr>
<tr class="separator:ab58b97edf0a420f63c3dc2ed29a05485"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aec24ec969dcf4df0185304ccbf6d653c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec24ec969dcf4df0185304ccbf6d653c"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>PulsarWrapper</b></td></tr>
<tr class="separator:aec24ec969dcf4df0185304ccbf6d653c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa780271d875c2e56f54098c4b03dadc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa780271d875c2e56f54098c4b03dadc"></a>
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (std::ostream &amp;os, const <a class="el" href="classpulsar_1_1_broker_consumer_stats.html">BrokerConsumerStats</a> &amp;obj)</td></tr>
<tr class="separator:aaa780271d875c2e56f54098c4b03dadc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a46bdf3a845d75f888d4ae6f840a3b5ce"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string pulsar::BrokerConsumerStats::getAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Address of this consumer </p>
</div>
</div>
<a class="anchor" id="a09cce823b8f5d304427ede767bc2529e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t pulsar::BrokerConsumerStats::getAvailablePermits </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Number of available message permits for the consumer </p>
</div>
</div>
<a class="anchor" id="ac03b51633cb154c978c7eee445f48d96"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string pulsar::BrokerConsumerStats::getConnectedSince </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Timestamp of connection </p>
</div>
</div>
<a class="anchor" id="a3806cd15b0c67a7fdb9d44df5834a4c2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string pulsar::BrokerConsumerStats::getConsumerName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Name of the consumer </p>
</div>
</div>
<a class="anchor" id="ab58b97edf0a420f63c3dc2ed29a05485"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::shared_ptr&lt;BrokerConsumerStatsImplBase&gt; pulsar::BrokerConsumerStats::getImpl </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a453c7d2e95d471d6ca3f3416bb9fc211"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t pulsar::BrokerConsumerStats::getMsgBacklog </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Number of messages in the subscription backlog </p>
</div>
</div>
<a class="anchor" id="a32ca24ab537319ef54d01d255a84c9bf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double pulsar::BrokerConsumerStats::getMsgRateExpired </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the rate of messages expired on this subscription. msg/s </p>
</div>
</div>
<a class="anchor" id="a3149c4040e0e8f23d7aad5fd0e6daef2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double pulsar::BrokerConsumerStats::getMsgRateOut </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the rate of messages delivered to the consumer. msg/s </p>
</div>
</div>
<a class="anchor" id="a16d93551fe5cc0eefb45355c364ec8fb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double pulsar::BrokerConsumerStats::getMsgRateRedeliver </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the rate of messages redelivered by this consumer. msg/s </p>
</div>
</div>
<a class="anchor" id="a94f8a62b3c43054350e1e43d261aa24a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double pulsar::BrokerConsumerStats::getMsgThroughputOut </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the throughput delivered to the consumer. bytes/s </p>
</div>
</div>
<a class="anchor" id="a6d0dfb988e6228ce4d70031a4940c3a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40">ConsumerType</a> pulsar::BrokerConsumerStats::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns Whether this subscription is Exclusive or Shared or Failover </p>
</div>
</div>
<a class="anchor" id="ad9d2d4b9275bc88fc918ee49cec3a1bc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t pulsar::BrokerConsumerStats::getUnackedMessages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Number of unacknowledged messages for the consumer </p>
</div>
</div>
<a class="anchor" id="a3fd64309f7ebc4ebf1322f3f52693aa5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool pulsar::BrokerConsumerStats::isBlockedConsumerOnUnackedMsgs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the consumer is blocked due to unacked messages. </p>
</div>
</div>
<a class="anchor" id="ab832325475970e501d0e10530696a8d1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool pulsar::BrokerConsumerStats::isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the Stats are still valid </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/pulsar/<a class="el" href="_broker_consumer_stats_8h_source.html">BrokerConsumerStats.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>