Add fallback to bswap_16 for gcc on Windows (closes #377)
[libmodbus.git] / doc / modbus_tcp_accept.txt
blob4c46d9079e240fdf785aaf75b8adc76910fd1b5f
1 modbus_tcp_accept(3)
2 ====================
5 NAME
6 ----
7 modbus_tcp_accept - accept a new connection on a TCP Modbus socket (IPv4)
10 SYNOPSIS
11 --------
12 *int modbus_tcp_accept(modbus_t *'ctx', int *'s);*
15 DESCRIPTION
16 -----------
17 The *modbus_tcp_accept()* function shall extract the first connection on the
18 queue of pending connections, create a new socket and store it in libmodbus
19 context given in argument. If available, _accept4()_ with `SOCK_CLOEXEC` will be
20 called instead of *accept()*.
23 RETURN VALUE
24 ------------
25 The function shall return a new socket if successful.
26 Otherwise it shall return -1 and set errno.
29 EXAMPLE
30 -------
31 For detailed example, see unit-test-server.c source file in tests directory.
33 [source,c]
34 -------------------
35 ...
37 ctx = modbus_new_tcp("127.0.0.1", 502);
38 s = modbus_tcp_listen(ctx, 1);
39 modbus_tcp_accept(ctx, &s);
41 ...
43 close(s)
44 modbus_free(ctx);
45 -------------------
47 SEE ALSO
48 --------
49 linkmb:modbus_tcp_pi_accept[3]
50 linkmb:modbus_tcp_listen[3]
51 linkmb:modbus_tcp_pi_listen[3]
53 AUTHORS
54 -------
55 The libmodbus documentation was written by Stéphane Raimbault
56 <stephane.raimbault@gmail.com>