File: modbus_set_response_timeout.txt

package info (click to toggle)
libmodbus 3.0.6-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 660 kB
  • ctags: 314
  • sloc: ansic: 4,031; makefile: 145; sh: 1
file content (54 lines) | stat: -rw-r--r-- 1,137 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
modbus_set_response_timeout(3)
==============================


NAME
----
modbus_set_response_timeout - set timeout for response


SYNOPSIS
--------
*void modbus_set_response_timeout(modbus_t *'ctx', struct timeval *'timeout');*


DESCRIPTION
-----------
The _modbus_set_response_timeout()_ function shall set the timeout interval used
to wait for a response. If the waiting before receiving the response is longer than
the given timeout, an error will be raised.


RETURN VALUE
------------
There is no return values.


EXAMPLE
-------
[source,c]
-------------------
struct timeval old_response_timeout;
struct timeval response_timeout;

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

/* Define a new and too short timeout! */
response_timeout.tv_sec = 0;
response_timeout.tv_usec = 0;
modbus_set_response_timeout(ctx, &response_timeout);
-------------------


SEE ALSO
--------
linkmb:modbus_get_response_timeout[3]
linkmb:modbus_get_byte_timeout[3]
linkmb:modbus_set_byte_timeout[3]


AUTHORS
-------
The libmodbus documentation was written by Stéphane Raimbault
<stephane.raimbault@gmail.com>