1GETSOCKOPT(2) Linux Programmer's Manual GETSOCKOPT(2)
2
6 getsockopt, setsockopt - get and set options on sockets
7
9 #include <sys/types.h> /* See NOTES */
10 #include <sys/socket.h>
11 int getsockopt(int sockfd, int level, int optname,
13 void *optval, socklen_t *optlen);
14 int setsockopt(int sockfd, int level, int optname,
15 const void *optval, socklen_t optlen);
16
18 getsockopt() and setsockopt() manipulate options for the socket re‐
19 ferred to by the file descriptor sockfd. Options may exist at multiple
20 protocol levels; they are always present at the uppermost socket level.
21 When manipulating socket options, the level at which the option resides
23 and the name of the option must be specified. To manipulate options at
24 the sockets API level, level is specified as SOL_SOCKET. To manipulate
25 options at any other level the protocol number of the appropriate pro‐
26 tocol controlling the option is supplied. For example, to indicate
27 that an option is to be interpreted by the TCP protocol, level should
28 be set to the protocol number of TCP; see getprotoent(3).
29 The arguments optval and optlen are used to access option values for
31 setsockopt(). For getsockopt() they identify a buffer in which the
32 value for the requested option(s) are to be returned. For getsock‐
33 opt(), optlen is a value-result argument, initially containing the size
34 of the buffer pointed to by optval, and modified on return to indicate
35 the actual size of the value returned. If no option value is to be
36 supplied or returned, optval may be NULL.
37 Optname and any specified options are passed uninterpreted to the ap‐
39 propriate protocol module for interpretation. The include file
40 <sys/socket.h> contains definitions for socket level options, described
41 below. Options at other protocol levels vary in format and name; con‐
42 sult the appropriate entries in section 4 of the manual.
43 Most socket-level options utilize an int argument for optval. For set‐
45 sockopt(), the argument should be nonzero to enable a boolean option,
46 or zero if the option is to be disabled.
47 For a description of the available socket options see socket(7) and the
49 appropriate protocol man pages.
50
52 On success, zero is returned for the standard options. On error, -1 is
53 returned, and errno is set appropriately.
54 Netfilter allows the programmer to define custom socket options with
56 associated handlers; for such options, the return value on success is
57 the value returned by the handler.
58
60 EBADF The argument sockfd is not a valid file descriptor.
61 EFAULT The address pointed to by optval is not in a valid part of the
63 process address space. For getsockopt(), this error may also be
64 returned if optlen is not in a valid part of the process address
65 space.
66 EINVAL optlen invalid in setsockopt(). In some cases this error can
68 also occur for an invalid value in optval (e.g., for the
69 IP_ADD_MEMBERSHIP option described in ip(7)).
70 ENOPROTOOPT
72 The option is unknown at the level indicated.
73 ENOTSOCK
75 The file descriptor sockfd does not refer to a socket.
76
78 POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD (these system calls first ap‐
79 peared in 4.2BSD).
80
82 POSIX.1 does not require the inclusion of <sys/types.h>, and this
83 header file is not required on Linux. However, some historical (BSD)
84 implementations required this header file, and portable applications
85 are probably wise to include it.
86 For background on the socklen_t type, see accept(2).
88
90 Several of the socket options should be handled at lower levels of the
91 system.
92
94 ioctl(2), socket(2), getprotoent(3), protocols(5), ip(7), packet(7),
95 socket(7), tcp(7), udp(7), unix(7)
96
98 This page is part of release 5.10 of the Linux man-pages project. A
99 description of the project, information about reporting bugs, and the
100 latest version of this page, can be found at
101 https://www.kernel.org/doc/man-pages/.
102Linux 2020-04-11 GETSOCKOPT(2)