doc/modbus_get_byte_timeout.txt

   1 modbus_get_byte_timeout(3)
   2 ==========================
   3
   4
   5 NAME
   6 ----
   7 modbus_get_byte_timeout - get timeout between bytes
   8
   9
  10 SYNOPSIS
  11 --------
  12 *int modbus_get_byte_timeout(modbus_t *'ctx', uint32_t *'to_sec', uint32_t *'to_usec');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The *modbus_get_byte_timeout()* function shall store the timeout interval
  18 between two consecutive bytes of the same message in the _to_sec_ and _to_usec_
  19 arguments.
  20
  21
  22 RETURN VALUE
  23 ------------
  24 The function shall return 0 if successful. Otherwise it shall return -1 and set
  25 errno.
  26
  27
  28 EXAMPLE
  29 -------
  30 [source,c]
  31 -------------------
  32 uint32_t to_sec;
  33 uint32_t to_usec;
  34
  35 /* Save original timeout */
  36 modbus_get_byte_timeout(ctx, &to_sec, &to_usec);
  37 -------------------
  38
  39
  40 SEE ALSO
  41 --------
  42 linkmb:modbus_get_response_timeout[3]
  43 linkmb:modbus_set_response_timeout[3]
  44 linkmb:modbus_set_byte_timeout[3]
  45
  46
  47 AUTHORS
  48 -------
  49 The libmodbus documentation was written by Stéphane Raimbault
  50 <stephane.raimbault@gmail.com>