[Boost-commit] svn:boost r85765 - trunk/libs/asio/doc

Subject: [Boost-commit] svn:boost r85765 - trunk/libs/asio/doc
From: chris_at_[hidden]
Date: 2013-09-17 18:32:13

Author: chris_kohlhoff
Date: 2013-09-17 18:32:13 EDT (Tue, 17 Sep 2013)
New Revision: 85765
URL: http://svn.boost.org/trac/boost/changeset/85765

Log:
Regenerate documentation.

Text files modified: 
   trunk/libs/asio/doc/reference.qbk |   119 +++++++++++++++++++++++++++++++++------ 
   1 files changed, 99 insertions(+), 20 deletions(-)

Modified: trunk/libs/asio/doc/reference.qbk
==============================================================================
--- trunk/libs/asio/doc/reference.qbk	Tue Sep 17 18:24:19 2013	(r85764)
+++ trunk/libs/asio/doc/reference.qbk	2013-09-17 18:32:13 EDT (Tue, 17 Sep 2013)	(r85765)
@@ -206,19 +206,25 @@
 [endsect]
 
 
-
 [section:asio_handler_invoke asio_handler_invoke]
 
 [indexterm1 asio_handler_invoke] 
 Default invoke function for handlers. 
 
-
+      
   template<
       typename Function>
-  void asio_handler_invoke(
-      Function function,
+  void ``[link boost_asio.reference.asio_handler_invoke.overload1 asio_handler_invoke]``(
+      Function & function,
       ... );
+  ``  [''''&raquo;''' [link boost_asio.reference.asio_handler_invoke.overload1 more...]]``
 
+  template<
+      typename Function>
+  void ``[link boost_asio.reference.asio_handler_invoke.overload2 asio_handler_invoke]``(
+      const Function & function,
+      ... );
+  ``  [''''&raquo;''' [link boost_asio.reference.asio_handler_invoke.overload2 more...]]``
 
 Completion handlers for asynchronous operations are invoked by the [link boost_asio.reference.io_service `io_service`] associated with the corresponding object (e.g. a socket or deadline\_timer). Certain guarantees are made on when the handler may be invoked, in particular that a handler can only be invoked from a thread that is currently calling `run()` on the corresponding [link boost_asio.reference.io_service `io_service`] object. Handlers may subsequently be invoked through other objects (such as [link boost_asio.reference.io_service__strand `io_service::strand`] objects) that provide additional guarantees.
 
@@ -226,12 +232,12 @@
 
 Implement asio\_handler\_invoke for your own handlers to specify a custom invocation strategy.
 
-This default implementation is simply: 
-
-   function();
+This default implementation invokes the function object like so: 
 
+   function(); 
 
 
+If necessary, the default implementation makes a copy of the function object so that the non-const operator() can be used.
 
 
 [heading Example]
@@ -258,9 +264,43 @@
 ['Convenience header: ][^boost/asio.hpp]
 
 
+[section:overload1 asio_handler_invoke (1 of 2 overloads)]
+
+
+Default handler invocation hook used for non-const function objects. 
+
+
+  template<
+      typename Function>
+  void asio_handler_invoke(
+      Function & function,
+      ... );
+
+
+
+[endsect]
+
+
+
+[section:overload2 asio_handler_invoke (2 of 2 overloads)]
+
+
+Default handler invocation hook used for const function objects. 
+
+
+  template<
+      typename Function>
+  void asio_handler_invoke(
+      const Function & function,
+      ... );
+
+
+
 [endsect]
 
 
+[endsect]
+
 
 [section:asio_handler_is_continuation asio_handler_is_continuation]
 
@@ -2609,7 +2649,7 @@
 
 * An error occurred.
 
-This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function.
+This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function, and is known as a ['composed operation]. The program must ensure that the device performs no ['overlapping] write operations (such as async\_write\_at, the device's async\_write\_some\_at function, or any other composed operations that perform writes) until this operation completes. Operations are overlapping if the regions defined by their offsets, and the numbers of bytes to write, intersect.
 
 
 [heading Parameters]
@@ -2682,7 +2722,7 @@
 
 * The completion\_condition function object returns 0.
 
-This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function.
+This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function, and is known as a ['composed operation]. The program must ensure that the device performs no ['overlapping] write operations (such as async\_write\_at, the device's async\_write\_some\_at function, or any other composed operations that perform writes) until this operation completes. Operations are overlapping if the regions defined by their offsets, and the numbers of bytes to write, intersect.
 
 
 [heading Parameters]
@@ -2768,7 +2808,7 @@
 
 * An error occurred.
 
-This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function.
+This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function, and is known as a ['composed operation]. The program must ensure that the device performs no ['overlapping] write operations (such as async\_write\_at, the device's async\_write\_some\_at function, or any other composed operations that perform writes) until this operation completes. Operations are overlapping if the regions defined by their offsets, and the numbers of bytes to write, intersect.
 
 
 [heading Parameters]
@@ -2831,7 +2871,7 @@
 
 * The completion\_condition function object returns 0.
 
-This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function.
+This operation is implemented in terms of zero or more calls to the device's async\_write\_some\_at function, and is known as a ['composed operation]. The program must ensure that the device performs no ['overlapping] write operations (such as async\_write\_at, the device's async\_write\_some\_at function, or any other composed operations that perform writes) until this operation completes. Operations are overlapping if the regions defined by their offsets, and the numbers of bytes to write, intersect.
 
 
 [heading Parameters]
@@ -3645,7 +3685,7 @@
 To receive into a single data buffer use the [link boost_asio.reference.buffer `buffer`]  function as follows: 
 
    socket.async_receive_from(
-       boost::asio::buffer(data, size), 0, sender_endpoint, handler); 
+       boost::asio::buffer(data, size), sender_endpoint, handler); 
 
 
 See the [link boost_asio.reference.buffer `buffer`]  documentation for information on receiving into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector. 
@@ -3802,7 +3842,7 @@
       WriteHandler handler);
 
 
-This function is used to send data on the datagram socket. The function call will block until the data has been sent successfully or an error occurs.
+This function is used to asynchronously send data on the datagram socket. The function call always returns immediately.
 
 
 [heading Parameters]
@@ -65410,7 +65450,9 @@
     [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
     [Create an iterator from an addrinfo list returned by getaddrinfo. 
 
-     Create an iterator from an endpoint, host name and service name. ]
+     Create an iterator from an endpoint, host name and service name. 
+
+     Create an iterator from a sequence of endpoints, host and service name. ]
   ]
   
   [
@@ -66185,7 +66227,9 @@
     [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
     [Create an iterator from an addrinfo list returned by getaddrinfo. 
 
-     Create an iterator from an endpoint, host name and service name. ]
+     Create an iterator from an endpoint, host name and service name. 
+
+     Create an iterator from a sequence of endpoints, host and service name. ]
   ]
   
   [
@@ -66284,7 +66328,20 @@
   ``  [''''&raquo;''' [link boost_asio.reference.ip__basic_resolver_iterator.create.overload2 more...]]``
 
 
-[section:overload1 ip::basic_resolver_iterator::create (1 of 2 overloads)]
+Create an iterator from a sequence of endpoints, host and service name. 
+
+
+  template<
+      typename ``[link boost_asio.reference.EndpointIterator EndpointIterator]``>
+  static basic_resolver_iterator ``[link boost_asio.reference.ip__basic_resolver_iterator.create.overload3 create]``(
+      EndpointIterator begin,
+      EndpointIterator end,
+      const std::string & host_name,
+      const std::string & service_name);
+  ``  [''''&raquo;''' [link boost_asio.reference.ip__basic_resolver_iterator.create.overload3 more...]]``
+
+
+[section:overload1 ip::basic_resolver_iterator::create (1 of 3 overloads)]
 
 
 Create an iterator from an addrinfo list returned by getaddrinfo. 
@@ -66301,7 +66358,7 @@
 
 
 
-[section:overload2 ip::basic_resolver_iterator::create (2 of 2 overloads)]
+[section:overload2 ip::basic_resolver_iterator::create (2 of 3 overloads)]
 
 
 Create an iterator from an endpoint, host name and service name. 
@@ -66317,6 +66374,26 @@
 [endsect]
 
 
+
+[section:overload3 ip::basic_resolver_iterator::create (3 of 3 overloads)]
+
+
+Create an iterator from a sequence of endpoints, host and service name. 
+
+
+  template<
+      typename ``[link boost_asio.reference.EndpointIterator EndpointIterator]``>
+  static basic_resolver_iterator create(
+      EndpointIterator begin,
+      EndpointIterator end,
+      const std::string & host_name,
+      const std::string & service_name);
+
+
+
+[endsect]
+
+
 [endsect]
 
 
@@ -69029,7 +69106,9 @@
     [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
     [Create an iterator from an addrinfo list returned by getaddrinfo. 
 
-     Create an iterator from an endpoint, host name and service name. ]
+     Create an iterator from an endpoint, host name and service name. 
+
+     Create an iterator from a sequence of endpoints, host and service name. ]
   ]
   
   [
@@ -83543,7 +83622,7 @@
   template<
       typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
       typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
-  void async_receive(
+  ``[link boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function ['void-or-deduced]]`` async_receive(
       implementation_type & impl,
       const MutableBufferSequence & buffers,
       socket_base::message_flags in_flags,
@@ -83565,7 +83644,7 @@
   template<
       typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
       typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
-  void async_send(
+  ``[link boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function ['void-or-deduced]]`` async_send(
       implementation_type & impl,
       const ConstBufferSequence & buffers,
       socket_base::message_flags flags,