doc/modbus_get_indication_timeout.txt

   1 modbus_get_indication_timeout(3)
   2 ================================
   3
   4
   5 NAME
   6 ----
   7 modbus_get_indication_timeout - get timeout used to wait for an indication (request received by a server).
   8
   9 SYNOPSIS
  10 --------
  11 *int modbus_get_indication_timeout(modbus_t *'ctx', uint32_t *'to_sec', uint32_t *'to_usec');*
  12
  13
  14 DESCRIPTION
  15 -----------
  16
  17 The *modbus_get_indication_timeout()* function shall store the timeout interval
  18 used to wait for an indication in the _to_sec_ and _to_usec_ arguments.
  19 Indication is the term used by the Modbus protocol to designate a request
  20 received by the server.
  21
  22 The default value is zero, it means the server will wait forever.
  23
  24
  25 RETURN VALUE
  26 ------------
  27 The function shall return 0 if successful. Otherwise it shall return -1 and set
  28 errno.
  29
  30
  31 EXAMPLE
  32 -------
  33 [source,c]
  34 -------------------
  35 uint32_t to_sec;
  36 uint32_t to_usec;
  37
  38 /* Save original timeout */
  39 modbus_get_indication_timeout(ctx, &to_sec, &to_usec);
  40 -------------------
  41
  42
  43 SEE ALSO
  44 --------
  45 linkmb:modbus_set_indication_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>