modbus_set_indication_timeout.txt 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. modbus_set_indication_timeout(3)
  2. ================================
  3. NAME
  4. ----
  5. modbus_set_indication_timeout - set timeout between indications
  6. SYNOPSIS
  7. --------
  8. *void modbus_set_indication_timeout(modbus_t *'ctx', uint32_t 'to_sec', uint32_t 'to_usec');*
  9. DESCRIPTION
  10. -----------
  11. The *modbus_set_indication_timeout()* function shall set the timeout interval used by
  12. a server to wait for a request from a client.
  13. The value of _to_usec_ argument must be in the range 0 to 999999.
  14. If both _to_sec_ and _to_usec_ are zero, this timeout will not be used at all.
  15. In this case, the server will wait forever.
  16. RETURN VALUE
  17. ------------
  18. The function shall return 0 if successful. Otherwise it shall return -1 and set
  19. errno.
  20. ERRORS
  21. ------
  22. *EINVAL*::
  23. The argument _ctx_ is NULL or _to_usec_ is larger than 1000000.
  24. SEE ALSO
  25. --------
  26. linkmb:modbus_get_indication_timeout[3]
  27. linkmb:modbus_get_response_timeout[3]
  28. linkmb:modbus_set_response_timeout[3]
  29. AUTHORS
  30. -------
  31. The libmodbus documentation was written by Stéphane Raimbault
  32. <stephane.raimbault@gmail.com>