1[/
2 / Copyright (c) 2003-2021 Christopher M. Kohlhoff (chris at kohlhoff dot com)
3 /
4 / Distributed under the Boost Software License, Version 1.0. (See accompanying
5 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6 /]
7
8[section:SettableSocketOption Settable socket option requirements]
9
10A type `X` meets the `SettableSocketOption` requirements if it satisfies the
11requirements listed below.
12
13In the table below, `a` denotes a (possibly const) value of type `X`, `p`
14denotes a (possibly const) value that meets the [link boost_asio.reference.Protocol
15`Protocol`] requirements, and `u` denotes an identifier.
16
17[table SettableSocketOption requirements for extensible implementations
18  [[expression] [type] [assertion/note[br]pre/post-conditions]]
19  [
20    [`a.level(p)`]
21    [`int`]
22    [
23      Returns a value suitable for passing as the /level/ argument to __POSIX__
24      __setsockopt__ (or equivalent).
25    ]
26  ]
27  [
28    [`a.name(p)`]
29    [`int`]
30    [
31      Returns a value suitable for passing as the /option_name/ argument to
32      __POSIX__ __setsockopt__ (or equivalent).
33    ]
34  ]
35  [
36    [`a.data(p)`]
37    [`const void*`]
38    [
39      Returns a pointer suitable for passing as the /option_value/ argument to
40      __POSIX__ __setsockopt__ (or equivalent).
41    ]
42  ]
43  [
44    [`a.size(p)`]
45    [`size_t`]
46    [
47      Returns a value suitable for passing as the /option_len/ argument to
48      __POSIX__ __setsockopt__ (or equivalent), after appropriate integer
49      conversion has been performed.
50    ]
51  ]
52]
53
54[endsect]
55