modbus_set_response_timeout - Man Page

set timeout for response

Synopsis

int modbus_set_response_timeout(modbus_t *ctx, uint32_t to_sec, uint32_t to_usec);

Description

The modbus_set_response_timeout() function shall set the timeout interval used to wait for a response. When a byte timeout is set, if elapsed time for the first byte of response is longer than the given timeout, an ETIMEDOUT error will be raised by the function waiting for a response. When byte timeout is disabled, the full confirmation response must be received before expiration of the response timeout.

The value of to_usec argument must be in the range 0 to 999999.

Return Value

The function shall return 0 if successful. Otherwise it shall return -1 and set errno.

Errors

EINVAL

The argument ctx is NULL, or both to_sec and to_usec are zero, or to_usec is larger than 1000000.

Example

uint32_t old_response_to_sec;
uint32_t old_response_to_usec;

/* Save original timeout */
modbus_get_response_timeout(ctx, &old_response_to_sec, &old_response_to_usec);

/* Define a new timeout of 200ms */
modbus_set_response_timeout(ctx, 0, 200000);

See Also

modbus_get_response_timeout(3) modbus_get_byte_timeout(3) modbus_set_byte_timeout(3)

Authors

The libmodbus documentation was written by Stéphane Raimbault <stephane.raimbault@gmail.com>

Referenced By

libmodbus(7), modbus_get_byte_timeout(3), modbus_get_response_timeout(3), modbus_set_byte_timeout(3).

07/21/2022 libmodbus v3.1.6 libmodbus Manual