1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Settable socket option requirements</title> 5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../reference.html" title="Reference"> 9<link rel="prev" href="SettableSerialPortOption.html" title="Settable serial port option requirements"> 10<link rel="next" href="ShutdownHandler.html" title="SSL shutdown handler requirements"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 15<td align="center"><a href="../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="SettableSerialPortOption.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ShutdownHandler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.SettableSocketOption"></a><a class="link" href="SettableSocketOption.html" title="Settable socket option requirements">Settable socket 28 option requirements</a> 29</h3></div></div></div> 30<p> 31 A type <code class="computeroutput">X</code> meets the <code class="computeroutput">SettableSocketOption</code> requirements 32 if it satisfies the requirements listed below. 33 </p> 34<p> 35 In the table below, <code class="computeroutput">a</code> denotes a (possibly const) value of type 36 <code class="computeroutput">X</code>, <code class="computeroutput">p</code> denotes a (possibly const) value that meets 37 the <a class="link" href="Protocol.html" title="Protocol requirements"><code class="computeroutput">Protocol</code></a> 38 requirements, and <code class="computeroutput">u</code> denotes an identifier. 39 </p> 40<div class="table"> 41<a name="boost_asio.reference.SettableSocketOption.t0"></a><p class="title"><b>Table 27. SettableSocketOption requirements for extensible implementations</b></p> 42<div class="table-contents"><table class="table" summary="SettableSocketOption requirements for extensible implementations"> 43<colgroup> 44<col> 45<col> 46<col> 47</colgroup> 48<thead><tr> 49<th> 50 <p> 51 expression 52 </p> 53 </th> 54<th> 55 <p> 56 type 57 </p> 58 </th> 59<th> 60 <p> 61 assertion/note<br> pre/post-conditions 62 </p> 63 </th> 64</tr></thead> 65<tbody> 66<tr> 67<td> 68 <p> 69 <code class="computeroutput">a.level(p)</code> 70 </p> 71 </td> 72<td> 73 <p> 74 <code class="computeroutput">int</code> 75 </p> 76 </td> 77<td> 78 <p> 79 Returns a value suitable for passing as the <span class="emphasis"><em>level</em></span> 80 argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html" target="_top"><code class="computeroutput"><span class="identifier">setsockopt</span><span class="special">()</span></code></a> 81 (or equivalent). 82 </p> 83 </td> 84</tr> 85<tr> 86<td> 87 <p> 88 <code class="computeroutput">a.name(p)</code> 89 </p> 90 </td> 91<td> 92 <p> 93 <code class="computeroutput">int</code> 94 </p> 95 </td> 96<td> 97 <p> 98 Returns a value suitable for passing as the <span class="emphasis"><em>option_name</em></span> 99 argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html" target="_top"><code class="computeroutput"><span class="identifier">setsockopt</span><span class="special">()</span></code></a> 100 (or equivalent). 101 </p> 102 </td> 103</tr> 104<tr> 105<td> 106 <p> 107 <code class="computeroutput">a.data(p)</code> 108 </p> 109 </td> 110<td> 111 <p> 112 <code class="computeroutput">const void*</code> 113 </p> 114 </td> 115<td> 116 <p> 117 Returns a pointer suitable for passing as the <span class="emphasis"><em>option_value</em></span> 118 argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html" target="_top"><code class="computeroutput"><span class="identifier">setsockopt</span><span class="special">()</span></code></a> 119 (or equivalent). 120 </p> 121 </td> 122</tr> 123<tr> 124<td> 125 <p> 126 <code class="computeroutput">a.size(p)</code> 127 </p> 128 </td> 129<td> 130 <p> 131 <code class="computeroutput">size_t</code> 132 </p> 133 </td> 134<td> 135 <p> 136 Returns a value suitable for passing as the <span class="emphasis"><em>option_len</em></span> 137 argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html" target="_top"><code class="computeroutput"><span class="identifier">setsockopt</span><span class="special">()</span></code></a> 138 (or equivalent), after appropriate integer conversion has been 139 performed. 140 </p> 141 </td> 142</tr> 143</tbody> 144</table></div> 145</div> 146<br class="table-break"> 147</div> 148<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 149<td align="left"></td> 150<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 151 Kohlhoff<p> 152 Distributed under the Boost Software License, Version 1.0. (See accompanying 153 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 154 </p> 155</div></td> 156</tr></table> 157<hr> 158<div class="spirit-nav"> 159<a accesskey="p" href="SettableSerialPortOption.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ShutdownHandler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 160</div> 161</body> 162</html> 163
