You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2019/03/07 16:49:00 UTC
[GitHub] [pulsar] david-streamlio opened a new issue #3780: Inaccurate
documentation for `availablePermits` in the admin-api-non-persistent-topics
documentation
david-streamlio opened a new issue #3780: Inaccurate documentation for `availablePermits` in the admin-api-non-persistent-topics documentation
URL: https://github.com/apache/pulsar/issues/3780
**Describe the bug**
The current definition of the `availablePermits` property on the http://pulsar.apache.org/docs/en/admin-api-non-persistent-topics.html#get-stats page is as follows:
"availablePermits: The number of messages this consumer has space for in the client library's listen queue. A value of 0 means the client library's queue is full and receive() isn't being called. A nonzero value means this consumer is ready to be dispatched messages."
However, this is incorrect, as we often times see a value of -1 for that setting, which is a nonzero value but is also indicative of the queue being full. Therefore I have corrected the definition to include that particular case as well.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to 'http://pulsar.apache.org/docs/en/admin-api-non-persistent-topics.html#get-stats'
2. Scroll down to ' availablePermits'
3. See error
**Expected behavior**
The definition for availablePermits should read as follows:
"availablePermits: The number of messages this consumer has space for in the client library's listen queue. A value less than 1 means the client library's queue is full and receive() isn't being called. A non-negative value means this consumer is ready to be dispatched messages."
**Screenshots**

**Desktop (please complete the following information):**
- All
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services