Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MODBUS_SET_RESPONSE_(3)	       libmodbus Manual	       MODBUS_SET_RESPONSE_(3)

NAME
       modbus_set_response_timeout - set timeout for response

SYNOPSIS
       int modbus_set_response_timeout(modbus_t	*ctx, uint32_t to_sec,
       uint32_t	to_usec);

DESCRIPTION
       The modbus_set_response_timeout() function shall	set the	timeout
       interval	used to	wait for a response. When a byte timeout is set, if
       elapsed time for	the first byte of response is longer than the given
       timeout,	an ETIMEDOUT error will	be raised by the function waiting for
       a response. When	byte timeout is	disabled, the full confirmation
       response	must be	received before	expiration of the response timeout.

       The value of to_usec argument must be in	the range 0 to 999999.

RETURN VALUE
       The function shall return 0 if successful. Otherwise it shall return -1
       and set errno.

ERRORS
       EINVAL
	   The argument	ctx is NULL, or	both to_sec and	to_usec	are zero, or
	   to_usec is larger than 1000000.

EXAMPLE
	   uint32_t old_response_to_sec;
	   uint32_t old_response_to_usec;

	   /* Save original timeout */
	   modbus_get_response_timeout(ctx, &old_response_to_sec, &old_response_to_usec);

	   /* Define a new timeout of 200ms */
	   modbus_set_response_timeout(ctx, 0, 200000);

SEE ALSO
       modbus_get_response_timeout(3) modbus_get_byte_timeout(3)
       modbus_set_byte_timeout(3)

AUTHORS
       The libmodbus documentation was written by Stphane Raimbault
       <stephane.raimbault@gmail.com>

libmodbus v3.1.7		  04/12/2025	       MODBUS_SET_RESPONSE_(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=modbus_set_response_timeout&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help