doc/modbus_set_byte_timeout.txt

   1 modbus_set_byte_timeout(3)
   2 ==========================
   3
   4
   5 NAME
   6 ----
   7 modbus_set_byte_timeout - set timeout between bytes
   8
   9
  10 SYNOPSIS
  11 --------
  12 *void modbus_set_byte_timeout(modbus_t *'ctx', long 'to_sec', long 'to_usec');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The _modbus_set_byte_timeout()_ function shall set the timeout interval between
  18 two consecutive bytes of the same message. If the delay between bytes is longer
  19 than the given timeout, the 'ETIMEDOUT' error will be raised by the the function
  20 waiting for a response.
  21
  22 The value of _to_usec_ argument must be in the range 0 to 999999.
  23
  24 If _to_sec_ is set to -1 then this timeout will not be used at all. In this
  25 case, _modbus_set_response_timeout()_ governs the entire handling of the
  26 response, the full confirmation response must be received before expiration of
  27 the response timeout. When a byte timeout is set, the response timeout is only
  28 used to wait for the first byte of the respone.
  29
  30
  31 RETURN VALUE
  32 ------------
  33 The function shall return 0 if successful. Otherwise it shall return -1 and set
  34 errno.
  35
  36
  37 ERRORS
  38 ------
  39 *EINVAL*::
  40 The argument _ctx_ is NULL or _to_usec_ is not smaller than 1000000.
  41
  42
  43 SEE ALSO
  44 --------
  45 linkmb:modbus_get_byte_timeout[3]
  46 linkmb:modbus_get_response_timeout[3]
  47 linkmb:modbus_set_response_timeout[3]
  48
  49
  50 AUTHORS
  51 -------
  52 The libmodbus documentation was written by Stéphane Raimbault
  53 <stephane.raimbault@gmail.com>