Sleep for delay of response timeout before reconnect (closes #77)

Thanks to Karl Palsson.

Sleep for delay of response timeout before reconnect (closes #77)
Thanks to Karl Palsson.
Stéphane Raimbault
1 parent ef81a69e
Showing 2 changed files with 24 additions and 17 deletions
doc/modbus_set_error_recovery.txt
src/modbus.c
@@ -23,19 +23,20 @@ By default there is no error recovery (&#39;MODBUS_ERROR_RECOVERY_NONE&#39;) so the
 application is responsible for controlling the error values returned by
 libmodbus functions and for handling them if necessary.
-When 'MODBUS_ERROR_RECOVERY_LINK' is set, the library will attempt an immediate
-reconnection (which may hang for several seconds if the network to the remote
-target unit is down). This mode will try a infinite close/connect loop until
-success on send call and will just try one time to retablish the connection on
-select/read calls (if the connecton was down, the values to read are certainly
-not available anymore after reconnection, except for slave/server). This mode
-will also run flush requests after a delay based on the current response timeout
-in some situations (eg. timeout of select call).
+When 'MODBUS_ERROR_RECOVERY_LINK' is set, the library will attempt an
+reconnection after a delay defined by response timeout of the libmodbus context.
+This mode will try a infinite close/connect loop until success on send call and
+will just try one time to retablish the connection on select/read calls (if the
+connecton was down, the values to read are certainly not available anymore after
+reconnection, except for slave/server). This mode will also run flush requests
+after a delay based on the current response timeout in some situations (eg.
+timeout of select call). The reconnection attempt can hang for several seconds
+if the network to the remote target unit is down.
 When 'MODBUS_ERROR_RECOVERY_PROTOCOL' is set, a sleep and flush sequence will be
 used to cleanup the ongoing communication, this can occurs when the message
 length is invalid, the TID is wrong or the received function code is not the
-expected one.
+expected one. The response timeout delay will be used to sleep.
 The modes are mask values and so they are complementary.
@@ -102,7 +102,7 @@ void _error_print(modbus_t *ctx, const char *context)
     }
 }
-static int _sleep_and_flush(modbus_t *ctx)
+static void _sleep_response_timeout(modbus_t *ctx)
 {
 #ifdef _WIN32
     /* usleep doesn't exist on Windows */
@@ -117,7 +117,6 @@ static int _sleep_and_flush(modbus_t *ctx)
     while (nanosleep(&request, &remaining) == -1 && errno == EINTR)
         request = remaining;
 #endif
-    return modbus_flush(ctx);
 }
 int modbus_flush(modbus_t *ctx)
@@ -192,9 +191,11 @@ static int send_msg(modbus_t *ctx, uint8_t *msg, int msg_length)
                 if ((errno == EBADF || errno == ECONNRESET || errno == EPIPE)) {
                     modbus_close(ctx);
+                    _sleep_response_timeout(ctx);
                     modbus_connect(ctx);
                 } else {
-                    _sleep_and_flush(ctx);
+                    _sleep_response_timeout(ctx);
+                    modbus_flush(ctx);
                 }
                 errno = saved_errno;
             }
@@ -379,7 +380,8 @@ int _modbus_receive_msg(modbus_t *ctx, uint8_t *msg, msg_type_t msg_type)
                 int saved_errno = errno;
                 if (errno == ETIMEDOUT) {
-                    _sleep_and_flush(ctx);
+                    _sleep_response_timeout(ctx);
+                    modbus_flush(ctx);
                 } else if (errno == EBADF) {
                     modbus_close(ctx);
                     modbus_connect(ctx);
@@ -494,7 +496,8 @@ static int check_confirmation(modbus_t *ctx, uint8_t *req,
         rc = ctx->backend->pre_check_confirmation(ctx, req, rsp, rsp_length);
         if (rc == -1) {
             if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) {
-                _sleep_and_flush(ctx);
+                _sleep_response_timeout(ctx);
+                modbus_flush(ctx);
             }
             return -1;
         }
@@ -538,7 +541,8 @@ static int check_confirmation(modbus_t *ctx, uint8_t *req,
                         function, req[offset]);
             }
             if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) {
-                _sleep_and_flush(ctx);
+                _sleep_response_timeout(ctx);
+                modbus_flush(ctx);
             }
             errno = EMBBADDATA;
             return -1;
@@ -587,7 +591,8 @@ static int check_confirmation(modbus_t *ctx, uint8_t *req,
             }
             if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) {
-                _sleep_and_flush(ctx);
+                _sleep_response_timeout(ctx);
+                modbus_flush(ctx);
             }
             errno = EMBBADDATA;
@@ -600,7 +605,8 @@ static int check_confirmation(modbus_t *ctx, uint8_t *req,
                     rsp_length, rsp_length_computed);
         }
         if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) {
-            _sleep_and_flush(ctx);
+            _sleep_response_timeout(ctx);
+            modbus_flush(ctx);
         }
         errno = EMBBADDATA;
         rc = -1;