| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>datagram_socket_service</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../../boost_asio.html" title="Boost.Asio"> |
| <link rel="up" href="../reference.html" title="Reference"> |
| <link rel="prev" href="const_buffers_1/value_type.html" title="const_buffers_1::value_type"> |
| <link rel="next" href="datagram_socket_service/assign.html" title="datagram_socket_service::assign"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="const_buffers_1/value_type.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="datagram_socket_service/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h3 class="title"> |
| <a name="boost_asio.reference.datagram_socket_service"></a><a class="link" href="datagram_socket_service.html" title="datagram_socket_service">datagram_socket_service</a> |
| </h3></div></div></div> |
| <p> |
| Default service implementation for a datagram socket. |
| </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">class</span> <span class="identifier">datagram_socket_service</span> <span class="special">:</span> |
| <span class="keyword">public</span> <span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span> |
| </pre> |
| <a name="boost_asio.reference.datagram_socket_service.types"></a><h5> |
| <a name="id1139587"></a> |
| <a class="link" href="datagram_socket_service.html#boost_asio.reference.datagram_socket_service.types">Types</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="datagram_socket_service/endpoint_type.html" title="datagram_socket_service::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| The endpoint type. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/implementation_type.html" title="datagram_socket_service::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| The type of a datagram socket. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/native_type.html" title="datagram_socket_service::native_type"><span class="bold"><strong>native_type</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| The native socket type. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/protocol_type.html" title="datagram_socket_service::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| The protocol type. |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="boost_asio.reference.datagram_socket_service.member_functions"></a><h5> |
| <a name="id1139762"></a> |
| <a class="link" href="datagram_socket_service.html#boost_asio.reference.datagram_socket_service.member_functions">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="datagram_socket_service/assign.html" title="datagram_socket_service::assign"><span class="bold"><strong>assign</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Assign an existing native socket to a datagram socket. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/async_connect.html" title="datagram_socket_service::async_connect"><span class="bold"><strong>async_connect</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous connect. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/async_receive.html" title="datagram_socket_service::async_receive"><span class="bold"><strong>async_receive</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous receive. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/async_receive_from.html" title="datagram_socket_service::async_receive_from"><span class="bold"><strong>async_receive_from</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous receive that will get the endpoint of the |
| sender. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/async_send.html" title="datagram_socket_service::async_send"><span class="bold"><strong>async_send</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous send. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/async_send_to.html" title="datagram_socket_service::async_send_to"><span class="bold"><strong>async_send_to</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous send. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/at_mark.html" title="datagram_socket_service::at_mark"><span class="bold"><strong>at_mark</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Determine whether the socket is at the out-of-band data mark. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/available.html" title="datagram_socket_service::available"><span class="bold"><strong>available</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Determine the number of bytes available for reading. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/bind.html" title="datagram_socket_service::bind"><span class="bold"><strong>bind</strong></span></a> |
| </p> |
| </td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/cancel.html" title="datagram_socket_service::cancel"><span class="bold"><strong>cancel</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Cancel all asynchronous operations associated with the socket. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/close.html" title="datagram_socket_service::close"><span class="bold"><strong>close</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Close a datagram socket implementation. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/connect.html" title="datagram_socket_service::connect"><span class="bold"><strong>connect</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Connect the datagram socket to the specified endpoint. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/construct.html" title="datagram_socket_service::construct"><span class="bold"><strong>construct</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Construct a new datagram socket implementation. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/datagram_socket_service.html" title="datagram_socket_service::datagram_socket_service"><span class="bold"><strong>datagram_socket_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Construct a new datagram socket service for the specified io_service. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/destroy.html" title="datagram_socket_service::destroy"><span class="bold"><strong>destroy</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Destroy a datagram socket implementation. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/get_io_service.html" title="datagram_socket_service::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Get the io_service object that owns the service. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/get_option.html" title="datagram_socket_service::get_option"><span class="bold"><strong>get_option</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Get a socket option. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/io_control.html" title="datagram_socket_service::io_control"><span class="bold"><strong>io_control</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Perform an IO control command on the socket. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/io_service.html" title="datagram_socket_service::io_service"><span class="bold"><strong>io_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| (Deprecated: use get_io_service().) Get the io_service object that |
| owns the service. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/is_open.html" title="datagram_socket_service::is_open"><span class="bold"><strong>is_open</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Determine whether the socket is open. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/local_endpoint.html" title="datagram_socket_service::local_endpoint"><span class="bold"><strong>local_endpoint</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Get the local endpoint. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/native.html" title="datagram_socket_service::native"><span class="bold"><strong>native</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Get the native socket implementation. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/open.html" title="datagram_socket_service::open"><span class="bold"><strong>open</strong></span></a> |
| </p> |
| </td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/receive.html" title="datagram_socket_service::receive"><span class="bold"><strong>receive</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Receive some data from the peer. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/receive_from.html" title="datagram_socket_service::receive_from"><span class="bold"><strong>receive_from</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Receive a datagram with the endpoint of the sender. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/remote_endpoint.html" title="datagram_socket_service::remote_endpoint"><span class="bold"><strong>remote_endpoint</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Get the remote endpoint. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/send.html" title="datagram_socket_service::send"><span class="bold"><strong>send</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Send the given data to the peer. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/send_to.html" title="datagram_socket_service::send_to"><span class="bold"><strong>send_to</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Send a datagram to the specified endpoint. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/set_option.html" title="datagram_socket_service::set_option"><span class="bold"><strong>set_option</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Set a socket option. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/shutdown.html" title="datagram_socket_service::shutdown"><span class="bold"><strong>shutdown</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Disable sends or receives on the socket. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="datagram_socket_service/shutdown_service.html" title="datagram_socket_service::shutdown_service"><span class="bold"><strong>shutdown_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Destroy all user-defined handler objects owned by the service. |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="boost_asio.reference.datagram_socket_service.data_members"></a><h5> |
| <a name="id1140748"></a> |
| <a class="link" href="datagram_socket_service.html#boost_asio.reference.datagram_socket_service.data_members">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="datagram_socket_service/id.html" title="datagram_socket_service::id"><span class="bold"><strong>id</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| The unique service identifier. |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <a name="boost_asio.reference.datagram_socket_service.requirements"></a><h5> |
| <a name="id1140833"></a> |
| <a class="link" href="datagram_socket_service.html#boost_asio.reference.datagram_socket_service.requirements">Requirements</a> |
| </h5> |
| <p> |
| <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/datagram_socket_service.hpp</code> |
| </p> |
| <p> |
| <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2003 - 2010 Christopher M. Kohlhoff<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="const_buffers_1/value_type.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="datagram_socket_service/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
