From: chris_at_[hidden]
Date: 2008-07-17 11:11:00
Author: chris_kohlhoff
Date: 2008-07-17 11:11:00 EDT (Thu, 17 Jul 2008)
New Revision: 47504
URL: http://svn.boost.org/trac/boost/changeset/47504
Log:
Merged revisions 47503 via svnmerge from
https://svn.boost.org/svn/boost/trunk
........
r47503 | chris_kohlhoff | 2008-07-18 01:05:24 +1000 (Fri, 18 Jul 2008) | 2 lines
Documentation updates.
........
Added:
branches/release/libs/asio/doc/index.xml
- copied unchanged from r47503, /trunk/libs/asio/doc/index.xml
branches/release/libs/asio/doc/overview/
- copied from r47503, /trunk/libs/asio/doc/overview/
branches/release/libs/asio/doc/overview.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview.qbk
branches/release/libs/asio/doc/overview/allocation.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/allocation.qbk
branches/release/libs/asio/doc/overview/async.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/async.qbk
branches/release/libs/asio/doc/overview/bsd_sockets.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/bsd_sockets.qbk
branches/release/libs/asio/doc/overview/buffers.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/buffers.qbk
branches/release/libs/asio/doc/overview/implementation.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/implementation.qbk
branches/release/libs/asio/doc/overview/iostreams.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/iostreams.qbk
branches/release/libs/asio/doc/overview/line_based.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/line_based.qbk
branches/release/libs/asio/doc/overview/posix.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/posix.qbk
branches/release/libs/asio/doc/overview/proactor.dot
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/proactor.dot
branches/release/libs/asio/doc/overview/proactor.png
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/proactor.png
branches/release/libs/asio/doc/overview/rationale.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/rationale.qbk
branches/release/libs/asio/doc/overview/reactor.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/reactor.qbk
branches/release/libs/asio/doc/overview/serial_ports.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/serial_ports.qbk
branches/release/libs/asio/doc/overview/ssl.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/ssl.qbk
branches/release/libs/asio/doc/overview/strands.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/strands.qbk
branches/release/libs/asio/doc/overview/streams.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/streams.qbk
branches/release/libs/asio/doc/overview/threads.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/threads.qbk
branches/release/libs/asio/doc/overview/timers.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/timers.qbk
branches/release/libs/asio/doc/overview/windows.qbk
- copied unchanged from r47503, /trunk/libs/asio/doc/overview/windows.qbk
Removed:
branches/release/libs/asio/doc/design/
branches/release/libs/asio/doc/design.qbk
Properties modified:
branches/release/ (props changed)
Text files modified:
branches/release/libs/asio/doc/Jamfile.v2 | 8 ++++----
branches/release/libs/asio/doc/asio.qbk | 21 +++++++++++++++------
branches/release/libs/asio/doc/examples.qbk | 27 +++++++++++++++++++++++++++
branches/release/libs/asio/doc/using.qbk | 7 +++++++
4 files changed, 53 insertions(+), 10 deletions(-)
Modified: branches/release/libs/asio/doc/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/doc/Jamfile.v2 (original)
+++ branches/release/libs/asio/doc/Jamfile.v2 2008-07-17 11:11:00 EDT (Thu, 17 Jul 2008)
@@ -24,14 +24,14 @@
install images
:
- design/proactor.png
+ overview/proactor.png
:
<location>html/boost_asio
;
local example-names = allocation buffers chat echo http/client http/server
- http/server2 http/server3 invocation iostreams multicast serialization
- services socks4 ssl timeouts timers ;
+ http/server2 http/server3 invocation iostreams local multicast nonblocking
+ porthopper serialization services socks4 ssl timeouts timers ;
for local l in $(example-names)
{
@@ -66,7 +66,7 @@
install asio_doc_images
:
- design/proactor.png
+ overview/proactor.png
:
<location>$(BOOST_ROOT)/doc/html/boost_asio
;
Modified: branches/release/libs/asio/doc/asio.qbk
==============================================================================
--- branches/release/libs/asio/doc/asio.qbk (original)
+++ branches/release/libs/asio/doc/asio.qbk 2008-07-17 11:11:00 EDT (Thu, 17 Jul 2008)
@@ -37,13 +37,21 @@
[/=============================================================================]
-Boost.Asio is a cross-platform C++ library for network programming that
-provides developers with a consistent asynchronous I/O model using a modern C++
-approach.
+Boost.Asio is a cross-platform C++ library for network and low-level I/O
+programming that provides developers with a consistent asynchronous model using
+a modern C++ approach.
[variablelist
[
[
+ [link boost_asio.overview Overview]
+ ]
+ [
+ An overview of the features included in Boost.Asio, plus rationale and design information.
+ ]
+ ]
+ [
+ [
[link boost_asio.using Using Boost.Asio]
]
[
@@ -80,16 +88,17 @@
]
[
[
- [link boost_asio.design Design]
+ [link boost_asio.index Index]
]
[
- Rationale and design information for Boost.Asio.
+ Book-style text index of Boost.Asio documentation.
]
]
]
+[include overview.qbk]
[include using.qbk]
[include tutorial.qbk]
[include examples.qbk]
[include reference.qbk]
-[include design.qbk]
+[xinclude index.xml]
Deleted: branches/release/libs/asio/doc/design.qbk
==============================================================================
--- branches/release/libs/asio/doc/design.qbk 2008-07-17 11:11:00 EDT (Thu, 17 Jul 2008)
+++ (empty file)
@@ -1,104 +0,0 @@
-[/
- / Copyright (c) 2003-2008 Christopher M. Kohlhoff (chris at kohlhoff dot com)
- /
- / Distributed under the Boost Software License, Version 1.0. (See accompanying
- / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
- /]
-
-[section:design Design Notes]
-
-[variablelist
- [
- [
- [link boost_asio.design.rationale Rationale]
- ]
- [
- Design rationale for the Boost.Asio library.
- ]
- ]
- [
- [
- [link boost_asio.design.async Asynchronous operations]
- ]
- [
- Support for asynchronous operations in the Boost.Asio library is based on
- the Proactor pattern. This design note outlines the advantages and
- disadvantages of this approach.
- ]
- ]
- [
- [
- [link boost_asio.design.allocation Custom memory allocation]
- ]
- [
- Describes the custom memory allocation support in Boost.Asio.
- ]
- ]
- [
- [
- [link boost_asio.design.buffers Buffers]
- ]
- [
- Examines the buffer abstraction used by asio in order to support
- scatter-gather operations.
- ]
- ]
- [
- [
- [link boost_asio.design.eof Why EOF is an error]
- ]
- [
- Discusses why the end-of-file condition should be an error code.
- ]
- ]
- [
- [
- [link boost_asio.design.line_based Line-based protocols]
- ]
- [
- Outlines Boost.Asio's support for line-based protocols.
- ]
- ]
- [
- [
- [link boost_asio.design.threads Threads]
- ]
- [
- An implementation of Boost.Asio for a particular platform may make use of
- one or more additional threads to emulate asynchronicity. This design
- note discusses design rules applied to the use of threads in this way.
- ]
- ]
- [
- [
- [link boost_asio.design.strands Strands]
- ]
- [
- Describes the "strand" abstraction provided by Boost.Asio to ease
- concurrent programming and provide scalability across multiple
- processors.
- ]
- ]
- [
- [
- [link boost_asio.design.implementation Platform-specific implementation]
- ]
- [
- This design note lists platform-specific implementation details, such as
- the default demultiplexing mechanism, the number of threads created
- internally, and when threads are created.
- ]
- ]
-]
-
-[include design/rationale.qbk]
-[include design/async.qbk]
-[include design/allocation.qbk]
-[include design/buffers.qbk]
-[include design/eof.qbk]
-[include design/line_based.qbk]
-[include design/threads.qbk]
-[include design/strands.qbk]
-[include design/implementation.qbk]
-
-[endsect]
Modified: branches/release/libs/asio/doc/examples.qbk
==============================================================================
--- branches/release/libs/asio/doc/examples.qbk (original)
+++ branches/release/libs/asio/doc/examples.qbk 2008-07-17 11:11:00 EDT (Thu, 17 Jul 2008)
@@ -219,4 +219,31 @@
* [@boost_asio/example/timers/time_t_timer.cpp]
+[heading Porthopper]
+
+Example illustrating mixed synchronous and asynchronous operations, and how to
+use Boost.Lambda with Boost.Asio.
+
+* [@boost_asio/example/porthopper/protocol.hpp]
+* [@boost_asio/example/porthopper/client.cpp]
+* [@boost_asio/example/porthopper/server.cpp]
+
+
+[heading Nonblocking]
+
+Example demonstrating reactor-style operations for integrating a third-party
+library that wants to perform the I/O operations itself.
+
+* [@boost_asio/example/nonblocking/third_party_lib.cpp]
+
+
+[heading UNIX Domain Sockets]
+
+Examples showing how to use UNIX domain (local) sockets.
+
+* [@boost_asio/example/local/connect_pair.cpp]
+* [@boost_asio/example/local/stream_server.cpp]
+* [@boost_asio/example/local/stream_client.cpp]
+
+
[endsect]
Modified: branches/release/libs/asio/doc/using.qbk
==============================================================================
--- branches/release/libs/asio/doc/using.qbk (original)
+++ branches/release/libs/asio/doc/using.qbk 2008-07-17 11:11:00 EDT (Thu, 17 Jul 2008)
@@ -264,4 +264,11 @@
]
]
+[heading Mailing List]
+
+A mailing list specifically for Boost.Asio may be found on
+[@http://sourceforge.net/mail/?group_id=122478 SourceForge.net]. Newsgroup
+access is provided via [@http://dir.gmane.org/gmane.comp.lib.boost.asio.user
+Gmane].
+
[endsect]