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', uint32_t 'to_sec', uint32_t '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. The timeout is an upper bound on the
  19 amount of time elapsed before *select()* returns, if the time elapsed is longer
  20 than the defined timeout, an `ETIMEDOUT` error will be raised by the
  21 function waiting for a response.
  22
  23 The value of _to_usec_ argument must be in the range 0 to 999999.
  24
  25 If both _to_sec_ and _to_usec_ are zero, this timeout will not be used at all.
  26 In this case, *modbus_set_response_timeout()* governs the entire handling of the
  27 response, the full confirmation response must be received before expiration of
  28 the response timeout. When a byte timeout is set, the response timeout is only
  29 used to wait for until the first byte of the response.
  30
  31
  32 RETURN VALUE
  33 ------------
  34 The function shall return 0 if successful. Otherwise it shall return -1 and set
  35 errno.
  36
  37
  38 ERRORS
  39 ------
  40 *EINVAL*::
  41 The argument _ctx_ is NULL or _to_usec_ is larger than 1000000.
  42
  43
  44 SEE ALSO
  45 --------
  46 linkmb:modbus_get_byte_timeout[3]
  47 linkmb:modbus_get_response_timeout[3]
  48 linkmb:modbus_set_response_timeout[3]
  49
  50
  51 AUTHORS
  52 -------
  53 The libmodbus documentation was written by Stéphane Raimbault
  54 <stephane.raimbault@gmail.com>