modbus_get_byte_timeout.txt 957 B

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