diff options
Diffstat (limited to 'doc/html/boost_asio/reference/basic_raw_socket.html')
| -rw-r--r-- | doc/html/boost_asio/reference/basic_raw_socket.html | 208 |
1 files changed, 85 insertions, 123 deletions
diff --git a/doc/html/boost_asio/reference/basic_raw_socket.html b/doc/html/boost_asio/reference/basic_raw_socket.html index f9ab6f481b..56e4a58b41 100644 --- a/doc/html/boost_asio/reference/basic_raw_socket.html +++ b/doc/html/boost_asio/reference/basic_raw_socket.html @@ -29,11 +29,10 @@ <p> Provides raw-oriented socket functionality. </p> -<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> - <span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span> - <span class="keyword">typename</span> <a class="link" href="RawSocketService.html" title="Raw socket service requirements">RawSocketService</a> <span class="special">=</span> <span class="identifier">raw_socket_service</span><span class="special"><</span><span class="identifier">Protocol</span><span class="special">>></span> -<span class="keyword">class</span> <span class="identifier">basic_raw_socket</span> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">basic_socket</span><span class="special"><</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">RawSocketService</span> <span class="special">></span> +<pre class="programlisting">template< + typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>> +class basic_raw_socket : + public basic_socket< Protocol > </pre> <h5> <a name="boost_asio.reference.basic_raw_socket.h0"></a> @@ -133,12 +132,12 @@ <tr> <td> <p> - <a class="link" href="basic_raw_socket/implementation_type.html" title="basic_raw_socket::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a> + <a class="link" href="basic_raw_socket/executor_type.html" title="basic_raw_socket::executor_type"><span class="bold"><strong>executor_type</strong></span></a> </p> </td> <td> <p> - The underlying implementation type of I/O object. + The type of the executor associated with the object. </p> </td> </tr> @@ -206,26 +205,12 @@ <tr> <td> <p> - <a class="link" href="basic_raw_socket/native_type.html" title="basic_raw_socket::native_type"><span class="bold"><strong>native_type</strong></span></a> + <a class="link" href="basic_raw_socket/out_of_band_inline.html" title="basic_raw_socket::out_of_band_inline"><span class="bold"><strong>out_of_band_inline</strong></span></a> </p> </td> <td> <p> - (Deprecated: Use native_handle_type.) The native representation - of a socket. - </p> - </td> -</tr> -<tr> -<td> - <p> - <a class="link" href="basic_raw_socket/non_blocking_io.html" title="basic_raw_socket::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a> - </p> - </td> -<td> - <p> - (Deprecated: Use non_blocking().) IO control command to set the - blocking mode of the socket. + Socket option for putting received out-of-band data inline. </p> </td> </tr> @@ -305,24 +290,24 @@ <tr> <td> <p> - <a class="link" href="basic_raw_socket/service_type.html" title="basic_raw_socket::service_type"><span class="bold"><strong>service_type</strong></span></a> + <a class="link" href="basic_raw_socket/shutdown_type.html" title="basic_raw_socket::shutdown_type"><span class="bold"><strong>shutdown_type</strong></span></a> </p> </td> <td> <p> - The type of the service that will be used to provide I/O operations. + Different ways a socket may be shutdown. </p> </td> </tr> <tr> <td> <p> - <a class="link" href="basic_raw_socket/shutdown_type.html" title="basic_raw_socket::shutdown_type"><span class="bold"><strong>shutdown_type</strong></span></a> + <a class="link" href="basic_raw_socket/wait_type.html" title="basic_raw_socket::wait_type"><span class="bold"><strong>wait_type</strong></span></a> </p> </td> <td> <p> - Different ways a socket may be shutdown. + Wait types. </p> </td> </tr> @@ -425,6 +410,19 @@ <tr> <td> <p> + <a class="link" href="basic_raw_socket/async_wait.html" title="basic_raw_socket::async_wait"><span class="bold"><strong>async_wait</strong></span></a> + </p> + </td> +<td> + <p> + Asynchronously wait for the socket to become ready to read, ready + to write, or to have pending error conditions. + </p> + </td> +</tr> +<tr> +<td> + <p> <a class="link" href="basic_raw_socket/at_mark.html" title="basic_raw_socket::at_mark"><span class="bold"><strong>at_mark</strong></span></a> </p> </td> @@ -526,12 +524,38 @@ <tr> <td> <p> + <a class="link" href="basic_raw_socket/get_executor.html" title="basic_raw_socket::get_executor"><span class="bold"><strong>get_executor</strong></span></a> + </p> + </td> +<td> + <p> + Get the executor associated with the object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="basic_raw_socket/get_io_context.html" title="basic_raw_socket::get_io_context"><span class="bold"><strong>get_io_context</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use get_executor().) Get the io_context associated + with the object. + </p> + </td> +</tr> +<tr> +<td> + <p> <a class="link" href="basic_raw_socket/get_io_service.html" title="basic_raw_socket::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a> </p> </td> <td> <p> - Get the io_service associated with the object. + (Deprecated: Use get_executor().) Get the io_context associated + with the object. </p> </td> </tr> @@ -601,18 +625,6 @@ <tr> <td> <p> - <a class="link" href="basic_raw_socket/native.html" title="basic_raw_socket::native"><span class="bold"><strong>native</strong></span></a> - </p> - </td> -<td> - <p> - (Deprecated: Use native_handle().) Get the native socket representation. - </p> - </td> -</tr> -<tr> -<td> - <p> <a class="link" href="basic_raw_socket/native_handle.html" title="basic_raw_socket::native_handle"><span class="bold"><strong>native_handle</strong></span></a> </p> </td> @@ -707,6 +719,18 @@ <tr> <td> <p> + <a class="link" href="basic_raw_socket/release.html" title="basic_raw_socket::release"><span class="bold"><strong>release</strong></span></a> + </p> + </td> +<td> + <p> + Release ownership of the underlying native socket. + </p> + </td> +</tr> +<tr> +<td> + <p> <a class="link" href="basic_raw_socket/remote_endpoint.html" title="basic_raw_socket::remote_endpoint"><span class="bold"><strong>remote_endpoint</strong></span></a> </p> </td> @@ -764,59 +788,35 @@ </p> </td> </tr> -</tbody> -</table></div> -<h5> -<a name="boost_asio.reference.basic_raw_socket.h2"></a> - <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.protected_member_functions"></a></span><a class="link" href="basic_raw_socket.html#boost_asio.reference.basic_raw_socket.protected_member_functions">Protected - Member Functions</a> - </h5> -<div class="informaltable"><table class="table"> -<colgroup> -<col> -<col> -</colgroup> -<thead><tr> -<th> - <p> - Name - </p> - </th> -<th> - <p> - Description - </p> - </th> -</tr></thead> -<tbody> <tr> <td> <p> - <a class="link" href="basic_raw_socket/get_implementation.html" title="basic_raw_socket::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a> + <a class="link" href="basic_raw_socket/wait.html" title="basic_raw_socket::wait"><span class="bold"><strong>wait</strong></span></a> </p> </td> <td> <p> - Get the underlying implementation of the I/O object. + Wait for the socket to become ready to read, ready to write, or + to have pending error conditions. </p> </td> </tr> <tr> <td> <p> - <a class="link" href="basic_raw_socket/get_service.html" title="basic_raw_socket::get_service"><span class="bold"><strong>get_service</strong></span></a> + <a class="link" href="basic_raw_socket/_basic_raw_socket.html" title="basic_raw_socket::~basic_raw_socket"><span class="bold"><strong>~basic_raw_socket</strong></span></a> </p> </td> <td> <p> - Get the service associated with the I/O object. + Destroys the socket. </p> </td> </tr> </tbody> </table></div> <h5> -<a name="boost_asio.reference.basic_raw_socket.h3"></a> +<a name="boost_asio.reference.basic_raw_socket.h2"></a> <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.data_members"></a></span><a class="link" href="basic_raw_socket.html#boost_asio.reference.basic_raw_socket.data_members">Data Members</a> </h5> @@ -846,117 +846,79 @@ </td> <td> <p> - The maximum length of the queue of pending incoming connections. - </p> - </td> -</tr> -<tr> -<td> - <p> - <a class="link" href="basic_raw_socket/message_do_not_route.html" title="basic_raw_socket::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a> - </p> - </td> -<td> - <p> - Specify that the data should not be subject to routing. + (Deprecated: Use max_listen_connections.) The maximum length of + the queue of pending incoming connections. </p> </td> </tr> <tr> <td> <p> - <a class="link" href="basic_raw_socket/message_end_of_record.html" title="basic_raw_socket::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a> + <a class="link" href="basic_raw_socket/max_listen_connections.html" title="basic_raw_socket::max_listen_connections"><span class="bold"><strong>max_listen_connections</strong></span></a> </p> </td> <td> <p> - Specifies that the data marks the end of a record. + The maximum length of the queue of pending incoming connections. </p> </td> </tr> <tr> <td> <p> - <a class="link" href="basic_raw_socket/message_out_of_band.html" title="basic_raw_socket::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a> + <a class="link" href="basic_raw_socket/message_do_not_route.html" title="basic_raw_socket::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a> </p> </td> <td> <p> - Process out-of-band data. + Specify that the data should not be subject to routing. </p> </td> </tr> <tr> <td> <p> - <a class="link" href="basic_raw_socket/message_peek.html" title="basic_raw_socket::message_peek"><span class="bold"><strong>message_peek</strong></span></a> + <a class="link" href="basic_raw_socket/message_end_of_record.html" title="basic_raw_socket::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a> </p> </td> <td> <p> - Peek at incoming data without removing it from the input queue. + Specifies that the data marks the end of a record. </p> </td> </tr> -</tbody> -</table></div> -<h5> -<a name="boost_asio.reference.basic_raw_socket.h4"></a> - <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.protected_data_members"></a></span><a class="link" href="basic_raw_socket.html#boost_asio.reference.basic_raw_socket.protected_data_members">Protected - Data Members</a> - </h5> -<div class="informaltable"><table class="table"> -<colgroup> -<col> -<col> -</colgroup> -<thead><tr> -<th> - <p> - Name - </p> - </th> -<th> - <p> - Description - </p> - </th> -</tr></thead> -<tbody> <tr> <td> <p> - <a class="link" href="basic_raw_socket/implementation.html" title="basic_raw_socket::implementation"><span class="bold"><strong>implementation</strong></span></a> + <a class="link" href="basic_raw_socket/message_out_of_band.html" title="basic_raw_socket::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a> </p> </td> <td> <p> - (Deprecated: Use get_implementation().) The underlying implementation - of the I/O object. + Process out-of-band data. </p> </td> </tr> <tr> <td> <p> - <a class="link" href="basic_raw_socket/service.html" title="basic_raw_socket::service"><span class="bold"><strong>service</strong></span></a> + <a class="link" href="basic_raw_socket/message_peek.html" title="basic_raw_socket::message_peek"><span class="bold"><strong>message_peek</strong></span></a> </p> </td> <td> <p> - (Deprecated: Use get_service().) The service associated with the - I/O object. + Peek at incoming data without removing it from the input queue. </p> </td> </tr> </tbody> </table></div> <p> - The <a class="link" href="basic_raw_socket.html" title="basic_raw_socket"><code class="computeroutput"><span class="identifier">basic_raw_socket</span></code></a> + The <a class="link" href="basic_raw_socket.html" title="basic_raw_socket"><code class="computeroutput">basic_raw_socket</code></a> class template provides asynchronous and blocking raw-oriented socket functionality. </p> <h5> -<a name="boost_asio.reference.basic_raw_socket.h5"></a> +<a name="boost_asio.reference.basic_raw_socket.h3"></a> <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.thread_safety"></a></span><a class="link" href="basic_raw_socket.html#boost_asio.reference.basic_raw_socket.thread_safety">Thread Safety</a> </h5> @@ -967,7 +929,7 @@ <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. </p> <h5> -<a name="boost_asio.reference.basic_raw_socket.h6"></a> +<a name="boost_asio.reference.basic_raw_socket.h4"></a> <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.requirements"></a></span><a class="link" href="basic_raw_socket.html#boost_asio.reference.basic_raw_socket.requirements">Requirements</a> </h5> <p> |