From 68480cee67f3eb928dadca5ca776f38119e231e7 Mon Sep 17 00:00:00 2001
From: Sadie Powell
Date: Fri, 21 Jul 2023 11:46:49 +0100
Subject: Add incremental backoff to the filter/permchannels/xline_db modules.

Closes #1671.
---
 docs/conf/modules.conf.example | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index 3011d5289..f495b6928 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -1909,12 +1909,20 @@
 # 'saveperiod' determines how often to check if the database needs to be
 # saved to disk. Defaults to every five seconds.
 #
+# 'backoff' is the value to multiply the saveperiod by every time a save
+# fails. When the save succeeds the period will be reset.
+#
+# 'maxbackoff' is the maximum write period that should be allowed even
+# if incremental backoff is enabled.
+#
 # 'operonly' determines whether a server operator or services server is
 # needed to enable the permchannels mode. You should generally keep this
 # set to yes unless you know what you are doing.
 #<permchanneldb filename="permchannels.conf"
 #               listmodes="yes"
 #               saveperiod="5s"
+#               backoff="2"
+#               maxbackoff="5m"
 #               operonly="yes">
 #<include file="permchannels.conf" missingokay="yes">
 #
@@ -2658,7 +2666,10 @@
 
 # Specify the filename for the xline database and how often to check whether
 # the database needs to be saved here.
-#<xlinedb filename="xline.db" saveperiod="5s">
+#<xlinedb filename="xline.db"
+#         saveperiod="5s"
+#         backoff="2"
+#         maxbackoff="5m">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #    ____                _   _____ _     _       ____  _ _   _        #
-- 
cgit v1.3.1-10-gc9f91