d0kuhn/mosquitto
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation of persistent_client_expiration option.

Browse Source 
Closes #2404. Thanks to Rainer Plischke.
This commit is contained in:
Roger A. Light 2022-05-19 17:04:20 +01:00
parent 09ac578459
commit 29c6480c47
3 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ChangeLog.txt
View File

@ -9,6 +9,8 @@ Broker:
MOSQ_EVT_MESSAGE event. MOSQ_EVT_MESSAGE event.
- Fix unused flags in CONNECT command being forced to be 0, which is not - Fix unused flags in CONNECT command being forced to be 0, which is not
required for MQTT v3.1. Closes #2522. required for MQTT v3.1. Closes #2522.
- Improve documentation of `persistent_client_expiration` option.
Closes #2404.
Client library: Client library:
- Fix threads library detection on Windows under cmake. Bumps the minimum - Fix threads library detection on Windows under cmake. Bumps the minimum

24
man/mosquitto.conf.5.xml
View File

@ -842,15 +842,21 @@ log_timestamp_format %Y-%m-%dT%H:%M:%S
<varlistentry> <varlistentry>
<term><option>persistent_client_expiration</option> <replaceable>duration</replaceable></term> <term><option>persistent_client_expiration</option> <replaceable>duration</replaceable></term>
<listitem> <listitem>
<para>This option allows persistent clients (those with <para>
clean session set to false) to be removed if they do This option allows the session of persistent clients (those with clean
not reconnect within a certain time frame. This is a session set to false) <emphasis>that are not currently connected</emphasis> to be removed if they
non-standard option. As far as the MQTT spec is do not reconnect within a certain time frame. This is a non-standard option
concerned, persistent clients persist forever.</para> in MQTT v3.1. MQTT v3.1.1 and v5.0 allow brokers to remove client sessions.
<para>Badly designed clients may set clean session to false </para>
whilst using a randomly generated client id. This leads
to persistent clients that will never reconnect. This <para>
option allows these clients to be removed.</para> Badly designed clients may set clean session to false whilst using a randomly
generated client id. This leads to persistent clients that connect once and
never reconnect. This option allows these clients to be removed. This option
allows persistent clients (those with clean session set to false) to be
removed if they do not reconnect within a certain time frame.
</para>
<para>The expiration period should be an integer followed <para>The expiration period should be an integer followed
by one of h d w m y for hour, day, week, month and year by one of h d w m y for hour, day, week, month and year
respectively. For example:</para> respectively. For example:</para>

14
mosquitto.conf
View File

@ -141,14 +141,16 @@
# accepted. MQTT imposes a maximum payload size of 268435455 bytes. # accepted. MQTT imposes a maximum payload size of 268435455 bytes.
#message_size_limit 0 #message_size_limit 0
# This option allows persistent clients (those with clean session set to false) # This option allows the session of persistent clients (those with clean
# to be removed if they do not reconnect within a certain time frame. # session set to false) that are not currently connected to be removed if they
# # do not reconnect within a certain time frame. This is a non-standard option
# This is a non-standard option in MQTT V3.1 but allowed in MQTT v3.1.1. # in MQTT v3.1. MQTT v3.1.1 and v5.0 allow brokers to remove client sessions.
# #
# Badly designed clients may set clean session to false whilst using a randomly # Badly designed clients may set clean session to false whilst using a randomly
# generated client id. This leads to persistent clients that will never # generated client id. This leads to persistent clients that connect once and
# reconnect. This option allows these clients to be removed. # never reconnect. This option allows these clients to be removed. This option
# allows persistent clients (those with clean session set to false) to be
# removed if they do not reconnect within a certain time frame.
# #
# The expiration period should be an integer followed by one of h d w m y for # The expiration period should be an integer followed by one of h d w m y for
# hour, day, week, month and year respectively. For example # hour, day, week, month and year respectively. For example