libmodbus/doc/modbus_set_byte_timeout.txt

modbus_set_byte_timeout(3)
==========================


NAME
----
modbus_set_byte_timeout - set timeout between bytes


SYNOPSIS
--------
*void modbus_set_byte_timeout(modbus_t *'ctx', long 'to_sec', long 'to_usec');*


DESCRIPTION
-----------
The _modbus_set_byte_timeout()_ function shall set the timeout interval between
two consecutive bytes of the same message. If the delay between bytes is longer
than the given timeout, the 'ETIMEDOUT' error will be raised by the the function
waiting for a response.

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

If _to_sec_ is set to -1 then this timeout will not be used at all. In this
case, _modbus_set_response_timeout()_ governs the entire handling of the
response, the full confirmation response must be received before expiration of
the response timeout. When a byte timeout is set, the response timeout is only
used to wait for the first byte of the response.


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 _to_usec_ is not smaller than 1000000.


SEE ALSO
--------
linkmb:modbus_get_byte_timeout[3]
linkmb:modbus_get_response_timeout[3]
linkmb:modbus_set_response_timeout[3]


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