ddns-scripts: rename variable: s/retry_count/retry_max_count/
authorRafał Miłecki <rafal@milecki.pl>
Tue, 27 Sep 2022 15:42:58 +0000 (17:42 +0200)
committerRafał Miłecki <rafal@milecki.pl>
Tue, 27 Sep 2022 15:42:58 +0000 (17:42 +0200)
Rename variable to make code easier to understand. This variable
specifies how many times ddns script should try to send a request.

Previous name ("retry_count") suggested it was for *counting* attempts.

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
net/ddns-scripts/files/usr/lib/ddns/dynamic_dns_functions.sh
net/ddns-scripts/files/usr/lib/ddns/dynamic_dns_updater.sh

index cb345e846be538bbc6239d0f513e0f6b32c28784..5026bd2133916fec8f16ba39ce3674e07c07f968 100644 (file)
@@ -627,11 +627,11 @@ verify_dns() {
                        return $__ERR
                elif [ $__ERR -ne 0 ]; then
                        __CNT=$(( $__CNT + 1 )) # increment error counter
-                       # if error count > retry_count leave here
-                       [ $retry_count -gt 0 -a $__CNT -gt $retry_count ] && \
-                               write_log 14 "Verify DNS server '$1' failed after $retry_count retries"
+                       # if error count > retry_max_count leave here
+                       [ $retry_max_count -gt 0 -a $__CNT -gt $retry_max_count ] && \
+                               write_log 14 "Verify DNS server '$1' failed after $retry_max_count retries"
 
-                       write_log 4 "Verify DNS server '$1' failed - retry $__CNT/$retry_count in $RETRY_SECONDS seconds"
+                       write_log 4 "Verify DNS server '$1' failed - retry $__CNT/$retry_max_count in $RETRY_SECONDS seconds"
                        sleep $RETRY_SECONDS &
                        PID_SLEEP=$!
                        wait $PID_SLEEP # enable trap-handler
@@ -687,11 +687,11 @@ verify_proxy() {
                        return $__ERR
                elif [ $__ERR -gt 0 ]; then
                        __CNT=$(( $__CNT + 1 )) # increment error counter
-                       # if error count > retry_count leave here
-                       [ $retry_count -gt 0 -a $__CNT -gt $retry_count ] && \
-                               write_log 14 "Verify Proxy server '$1' failed after $retry_count retries"
+                       # if error count > retry_max_count leave here
+                       [ $retry_max_count -gt 0 -a $__CNT -gt $retry_max_count ] && \
+                               write_log 14 "Verify Proxy server '$1' failed after $retry_max_count retries"
 
-                       write_log 4 "Verify Proxy server '$1' failed - retry $__CNT/$retry_count in $RETRY_SECONDS seconds"
+                       write_log 4 "Verify Proxy server '$1' failed - retry $__CNT/$retry_max_count in $RETRY_SECONDS seconds"
                        sleep $RETRY_SECONDS &
                        PID_SLEEP=$!
                        wait $PID_SLEEP # enable trap-handler
@@ -867,11 +867,11 @@ do_transfer() {
                }
 
                __CNT=$(( $__CNT + 1 )) # increment error counter
-               # if error count > retry_count leave here
-               [ $retry_count -gt 0 -a $__CNT -gt $retry_count ] && \
-                       write_log 14 "Transfer failed after $retry_count retries"
+               # if error count > retry_max_count leave here
+               [ $retry_max_count -gt 0 -a $__CNT -gt $retry_max_count ] && \
+                       write_log 14 "Transfer failed after $retry_max_count retries"
 
-               write_log 4 "Transfer failed - retry $__CNT/$retry_count in $RETRY_SECONDS seconds"
+               write_log 4 "Transfer failed - retry $__CNT/$retry_max_count in $RETRY_SECONDS seconds"
                sleep $RETRY_SECONDS &
                PID_SLEEP=$!
                wait $PID_SLEEP # enable trap-handler
@@ -1058,10 +1058,10 @@ get_local_ip () {
                }
 
                __CNT=$(( $__CNT + 1 )) # increment error counter
-               # if error count > retry_count leave here
-               [ $retry_count -gt 0 -a $__CNT -gt $retry_count ] && \
-                       write_log 14 "Get local IP via '$ip_source' failed after $retry_count retries"
-               write_log 4 "Get local IP via '$ip_source' failed - retry $__CNT/$retry_count in $RETRY_SECONDS seconds"
+               # if error count > retry_max_count leave here
+               [ $retry_max_count -gt 0 -a $__CNT -gt $retry_max_count ] && \
+                       write_log 14 "Get local IP via '$ip_source' failed after $retry_max_count retries"
+               write_log 4 "Get local IP via '$ip_source' failed - retry $__CNT/$retry_max_count in $RETRY_SECONDS seconds"
                sleep $RETRY_SECONDS &
                PID_SLEEP=$!
                wait $PID_SLEEP # enable trap-handler
@@ -1200,11 +1200,11 @@ get_registered_ip() {
                }
 
                __CNT=$(( $__CNT + 1 )) # increment error counter
-               # if error count > retry_count leave here
-               [ $retry_count -gt 0 -a $__CNT -gt $retry_count ] && \
-                       write_log 14 "Get registered/public IP for '$lookup_host' failed after $retry_count retries"
+               # if error count > retry_max_count leave here
+               [ $retry_max_count -gt 0 -a $__CNT -gt $retry_max_count ] && \
+                       write_log 14 "Get registered/public IP for '$lookup_host' failed after $retry_max_count retries"
 
-               write_log 4 "Get registered/public IP for '$lookup_host' failed - retry $__CNT/$retry_count in $RETRY_SECONDS seconds"
+               write_log 4 "Get registered/public IP for '$lookup_host' failed - retry $__CNT/$retry_max_count in $RETRY_SECONDS seconds"
                sleep $RETRY_SECONDS &
                PID_SLEEP=$!
                wait $PID_SLEEP # enable trap-handler
index 8176fa74c636ac8525d1f24a0409bf3c7411dbbe..47b2abfdf2462754d56d31718a8520ac0a64cec9 100644 (file)
@@ -159,7 +159,7 @@ trap "trap_handler 15" 15   # SIGTERM       Termination
 #
 # retry_interval       if error was detected retry in
 # retry_unit           'days' 'hours' 'minutes' 'seconds'
-# retry_count          number of retries before scripts stops
+# retry_max_count      number of retries before scripts stops
 #
 # use_ipv6             detecting/sending IPv6 address
 # force_ipversion      force usage of IPv4 or IPv6 for the whole detection and update communication
@@ -180,7 +180,7 @@ ERR_LAST=$? # save return code - equal 0 if SECTION_ID found
 
 # set defaults if not defined
 [ -z "$enabled" ]        && enabled=0
-[ -z "$retry_count" ]    && retry_count=0      # endless retry
+[ -z "$retry_max_count" ] && retry_max_count=0 # endless retry
 [ -z "$use_syslog" ]      && use_syslog=2      # syslog "Notice"
 [ -z "$use_https" ]       && use_https=0       # not use https
 [ -z "$use_logfile" ]     && use_logfile=1     # use logfile by default
@@ -293,7 +293,7 @@ get_seconds RETRY_SECONDS ${retry_interval:-60} ${retry_unit:-"seconds"} # defau
 write_log 7 "check interval: $CHECK_SECONDS seconds"
 write_log 7 "force interval: $FORCE_SECONDS seconds"
 write_log 7 "retry interval: $RETRY_SECONDS seconds"
-write_log 7 "retry counter : $retry_count times"
+write_log 7 "retry max count : $retry_max_count times"
 
 # kill old process if it exists & set new pid file
 stop_section_processes "$SECTION_ID"
@@ -412,9 +412,9 @@ while : ; do
        if [ "$LOCAL_IP" != "$REGISTERED_IP" ]; then
                if [ $VERBOSE -le 1 ]; then     # VERBOSE <=1 then retry
                        ERR_UPDATE=$(( $ERR_UPDATE + 1 ))
-                       [ $retry_count -gt 0 -a $ERR_UPDATE -gt $retry_count ] && \
-                               write_log 14 "Updating IP at DDNS provider failed after $retry_count retries"
-                       write_log 4 "Updating IP at DDNS provider failed - starting retry $ERR_UPDATE/$retry_count"
+                       [ $retry_max_count -gt 0 -a $ERR_UPDATE -gt $retry_max_count ] && \
+                               write_log 14 "Updating IP at DDNS provider failed after $retry_max_count retries"
+                       write_log 4 "Updating IP at DDNS provider failed - starting retry $ERR_UPDATE/$retry_max_count"
                        continue # loop to beginning
                else
                        write_log 4 "Updating IP at DDNS provider failed"