-
Notifications
You must be signed in to change notification settings - Fork 118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix some typos in the README. #91
Conversation
carwynmoore
commented
Jul 15, 2016
- Renamed MaxInFlight to MaxInflight (lowercase f) to match code.
- Adding missing double quote
@@ -167,10 +167,10 @@ This mismatch is commonly called a "fast producer/slow consumer" problem, and ma | |||
|
|||
### Publisher rate limiting | |||
|
|||
NATS Streaming provides a connection option called `MaxPubAcksInFlight` that effectively limits the number of unacknowledged messages that a publisher may have in-flight at any given time. When this maximum is reached, further `PublishAsync()` calls will block until the number of unacknowledged messages falls below the specified limit. ex: | |||
NATS Streaming provides a connection option called `MaxPubAcksInflight` that effectively limits the number of unacknowledged messages that a publisher may have in-flight at any given time. When this maximum is reached, further `PublishAsync()` calls will block until the number of unacknowledged messages falls below the specified limit. ex: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The property MaxPubAcksInflight
is really incorrectly named. It really should be MaxPubAcksInFlight
. It always stumps me. Likely the time to make the change is now or never.
@kozlovic @ColinSullivan1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps add the new one and deprecate the API. I hate to make breaking changes past alpha/beta.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So now my question is what about PR #88, where we provide an option setter that I have named MaxPubAcksInFlight
, should it stay this way? If users use the new option setter to set that option, it will be less of an issue if it is not named properly (since they won't directly reference the option itself). Comments?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep theMaxPubsAckInFlight
option, the code at least will look correct. However with other language client implementations we need to be careful, or we need to normalize. We can take this offline.
LGTM - Thank you @carwynmoore for the contribution! |