Skip to content
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

Documentation error about Session Expiry Interval property. #1034

Open
1 task
freyssin opened this issue Apr 5, 2024 · 0 comments
Open
1 task

Documentation error about Session Expiry Interval property. #1034

freyssin opened this issue Apr 5, 2024 · 0 comments

Comments

@freyssin
Copy link

freyssin commented Apr 5, 2024

Please fill out the form below before submitting, thank you!

  • [ X] Bug exists Release Version 1.2.5 ( Master Branch)
  • Bug exists in MQTTv3 Client on Snapshot Version 1.2.6-SNAPSHOT (Develop Branch)
  • [ X] Bug exists in MQTTv5 Client on Snapshot Version 1.2.6-SNAPSHOT (Develop Branch)

The Javadoc of the methods getSessionExpiryInterval (L498-506) and setSessionExpiryInterval (L508-529) in MqttConnectionOptions class are false and seriously mislead the user. This javadoc states that "By default this value is null and so will not be sent, in this case, the session will not expire.". The first part of the sentence is true, the second is false. Indeed, in the section 3.1.2.11.2 the MQTT v5 specification says: "If the Session Expiry Interval is absent the value 0 is used. If it is set to 0, or is absent, the Session ends when the Network Connection is closed."

The error is also present in comment line 102.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant