Use new modbus_mapping_new_start_address in unit tests
[libmodbus.git] / doc / modbus_receive.txt
blob460d19b7572755507d5a94e22e68d7d22c4f5989
1 modbus_receive(3)
2 =================
5 NAME
6 ----
7 modbus_receive - receive an indication request
10 SYNOPSIS
11 --------
12 *int modbus_receive(modbus_t *'ctx', uint8_t *'req');*
15 DESCRIPTION
16 -----------
17 The *modbus_receive()* function shall receive an indication request from the
18 socket of the context _ctx_. This function is used by Modbus slave/server to
19 receive and analyze indication request sent by the masters/clients.
21 If you need to use another socket or file descriptor than the one defined in the
22 context _ctx_, see the function linkmb:modbus_set_socket[3].
25 RETURN VALUE
26 ------------
27 The function shall store the indication request in _req_ and return the request
28 length if successful. The returned request length can be zero if the indication
29 request is ignored (eg. a query for another slave in RTU mode). Otherwise it
30 shall return -1 and set errno.
33 SEE ALSO
34 --------
35 linkmb:modbus_set_socket[3]
36 linkmb:modbus_reply[3]
39 AUTHORS
40 -------
41 The libmodbus documentation was written by Stéphane Raimbault
42 <stephane.raimbault@gmail.com>