Update of /cvsroot/boost/boost/libs/asio/doc/design
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv24810/design
Modified Files:
allocation.qbk buffers.qbk eof.qbk line_based.qbk threads.qbk
Added Files:
rationale.qbk
Log Message:
Documentation updates.
--- NEW FILE: rationale.qbk ---
[/
/ Copyright (c) 2003-2007 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:rationale Rationale]
The Boost.Asio library is intended for programmers using C++ for systems
programming, where access to operating system functionality such as networking
is often required. In particular, Boost.Asio attempts to address the following
goals:
* [*Portability.] The library should support, and provide consistent behaviour
across, a range of commonly used operating systems.
* [*Scalability.] The library should allow, and indeed encourage, the
development of network applications that scale to hundreds or thousands of
concurrent connections. The library implementation for each operating system
should use the mechanism that best enables this scalability.
* [*Efficiency.] The library should support techniques such as scatter-gather
I/O, and allow protocol implementations that minimise data copying.
* [*Model Berkeley sockets.] The Berkeley sockets API is widely implemented and
understood, as well as being covered in much literature. Other programming
languages often use a similar interface for networking APIs.
* [*Ease of use.] Lower the entry barrier for new users by taking a toolkit,
rather than framework, approach. That is, try to minimise the up-front
investment in time to just learning a few basic rules and guidelines. After
that, a library user should only need to understand the specific functions that
are being used.
* [*Basis for further abstraction.] The library should permit the development
of other libraries that provide higher levels of abstraction. For example,
implementations of commonly used protocols such as HTTP.
Although the current incarnation of Boost.Asio focuses primarily on networking,
its concepts of asynchronous I/O can be extended to include other operating
system resources such as files.
[endsect]
Index: allocation.qbk
===================================================================
RCS file: /cvsroot/boost/boost/libs/asio/doc/design/allocation.qbk,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- allocation.qbk 7 May 2007 12:41:29 -0000 1.2
+++ allocation.qbk 16 May 2007 14:35:09 -0000 1.3
@@ -5,7 +5,7 @@
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
-[section Custom Memory Allocation]
+[section:allocation Custom Memory Allocation]
Many asynchronous operations need to allocate an object to store state
associated with the operation. For example, a Win32 implementation needs
Index: buffers.qbk
===================================================================
RCS file: /cvsroot/boost/boost/libs/asio/doc/design/buffers.qbk,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- buffers.qbk 19 Jan 2007 01:20:15 -0000 1.1
+++ buffers.qbk 16 May 2007 14:35:09 -0000 1.2
@@ -5,7 +5,7 @@
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
-[section Buffers]
+[section:buffers Buffers]
To allow the development of efficient network applications, Boost.Asio includes
support for scatter-gather operations. These operations involve one or more
Index: eof.qbk
===================================================================
RCS file: /cvsroot/boost/boost/libs/asio/doc/design/eof.qbk,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- eof.qbk 19 Jan 2007 01:20:15 -0000 1.1
+++ eof.qbk 16 May 2007 14:35:09 -0000 1.2
@@ -5,7 +5,7 @@
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
-[section Why EOF is an error]
+[section:eof Why EOF is an error]
* The end of a stream can cause `read`, `async_read`, `read_until` or
`async_read_until` functions to violate their contract. E.g.
Index: line_based.qbk
===================================================================
RCS file: /cvsroot/boost/boost/libs/asio/doc/design/line_based.qbk,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- line_based.qbk 19 Jan 2007 01:20:15 -0000 1.1
+++ line_based.qbk 16 May 2007 14:35:09 -0000 1.2
@@ -5,7 +5,7 @@
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
-[section Line-Based Protocols]
+[section:line_based Line-Based Protocols]
Many commonly-used internet protocols are line-based, which means that they
have protocol elements that are delimited by the character sequence `"\r\n"`.
Index: threads.qbk
===================================================================
RCS file: /cvsroot/boost/boost/libs/asio/doc/design/threads.qbk,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- threads.qbk 19 Jan 2007 01:20:15 -0000 1.1
+++ threads.qbk 16 May 2007 14:35:09 -0000 1.2
@@ -5,7 +5,7 @@
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
-[section Threads]
+[section:threads Threads]
[heading Thread Safety]
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
