boost/asio
2
0
Fork 0
mirror of https://github.com/boostorg/asio.git synced 2026-01-19 04:02:09 +00:00
Code Issues Projects Releases Wiki Activity

Merge asio doc fixes from release branch.

Browse Source 
[SVN r43640]
This commit is contained in:
Christopher Kohlhoff
2008-03-15 22:37:58 +00:00
parent adab7d88e0
commit 601a882f6e
3 changed files with 182 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
doc/Jamfile.v2
View File

@@ -7,14 +7,40 @@
using quickbook ;
xml asio
########################################################################
# Standalone HTML documentation
xml standalone_doc
:
asio.qbk
;
install css
:
/boost//doc/html/boostbook.css
:
<location>html
;
install images
:
design/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 ;
for local l in $(example-names)
{
install ex_$(l) : [ glob ../example/$(l)/*.*pp ] : <location>html/boost_asio/example/$(l) ;
}
boostbook standalone
:
asio
standalone_doc
:
<xsl:param>boost.root=../../../..
<xsl:param>boost.libraries=../../../../libs/libraries.htm
@@ -28,9 +54,50 @@ boostbook standalone
<xsl:param>generate.toc="chapter nop section nop"
;
########################################################################
# HTML documentation for $(BOOST_ROOT)/doc/html
install html
xml asio_doc
:
/boost//doc/html/boostbook.css
design/proactor.png
asio.qbk
;
explicit asio_doc ;
install asio_doc_images
:
design/proactor.png
:
<location>$(BOOST_ROOT)/doc/html/boost_asio
;
explicit asio_doc_images ;
for local l in $(example-names)
{
install asio_ex_$(l) : [ glob ../example/$(l)/*.*pp ] : <location>$(BOOST_ROOT)/doc/html/boost_asio/example/$(l) ;
explicit asio_ex_$(l) ;
}
alias asio_examples : asio_ex_$(example-names) ;
explicit asio_examples ;
boostbook asio
:
asio_doc
:
<xsl:param>chapter.autolabel=0
<xsl:param>chunk.section.depth=8
<xsl:param>chunk.first.sections=1
<xsl:param>toc.section.depth=2
<xsl:param>toc.max.depth=1
<xsl:param>generate.section.toc.level=1
<xsl:param>generate.toc="chapter nop section nop"
<xsl:param>root.filename=boost_asio
:
<dependency>asio_doc_images
<dependency>asio_examples
;
explicit asio ;

180
doc/examples.qbk
View File

@@ -13,7 +13,7 @@
This example shows how to customise the allocation of memory associated with
asynchronous operations.
* [@../../example/allocation/server.cpp]
* [@boost_asio/example/allocation/server.cpp]
[heading Buffers]
@@ -21,7 +21,7 @@ asynchronous operations.
This example demonstrates how to create reference counted buffers that can be
used with socket read and write operations.
* [@../../example/buffers/reference_counted.cpp]
* [@boost_asio/example/buffers/reference_counted.cpp]
[heading Chat]
@@ -29,9 +29,9 @@ used with socket read and write operations.
This example implements a chat server and client. The programs use a custom
protocol with a fixed length message header and variable length message body.
* [@../../example/chat/chat_message.hpp]
* [@../../example/chat/chat_client.cpp]
* [@../../example/chat/chat_server.cpp]
* [@boost_asio/example/chat/chat_message.hpp]
* [@boost_asio/example/chat/chat_client.cpp]
* [@boost_asio/example/chat/chat_server.cpp]
[heading Echo]
@@ -39,12 +39,12 @@ protocol with a fixed length message header and variable length message body.
A collection of simple clients and servers, showing the use of both synchronous
and asynchronous operations.
* [@../../example/echo/async_tcp_echo_server.cpp]
* [@../../example/echo/async_udp_echo_server.cpp]
* [@../../example/echo/blocking_tcp_echo_client.cpp]
* [@../../example/echo/blocking_tcp_echo_server.cpp]
* [@../../example/echo/blocking_udp_echo_client.cpp]
* [@../../example/echo/blocking_udp_echo_server.cpp]
* [@boost_asio/example/echo/async_tcp_echo_server.cpp]
* [@boost_asio/example/echo/async_udp_echo_server.cpp]
* [@boost_asio/example/echo/blocking_tcp_echo_client.cpp]
* [@boost_asio/example/echo/blocking_tcp_echo_server.cpp]
* [@boost_asio/example/echo/blocking_udp_echo_client.cpp]
* [@boost_asio/example/echo/blocking_udp_echo_server.cpp]
[heading HTTP Client]
@@ -53,8 +53,8 @@ Example programs implementing simple HTTP 1.0 clients. These examples show how
to use the [link boost_asio.reference.read_until read_until] and [link
boost_asio.reference.async_read_until async_read_until] functions.
* [@../../example/http/client/sync_client.cpp]
* [@../../example/http/client/async_client.cpp]
* [@boost_asio/example/http/client/sync_client.cpp]
* [@boost_asio/example/http/client/async_client.cpp]
[heading HTTP Server]
@@ -63,70 +63,70 @@ This example illustrates the use of asio in a simple single-threaded server
implementation of HTTP 1.0. It demonstrates how to perform a clean shutdown by
cancelling all outstanding asynchronous operations.
* [@../../example/http/server/connection.cpp]
* [@../../example/http/server/connection.hpp]
* [@../../example/http/server/connection_manager.cpp]
* [@../../example/http/server/connection_manager.hpp]
* [@../../example/http/server/header.hpp]
* [@../../example/http/server/mime_types.cpp]
* [@../../example/http/server/mime_types.hpp]
* [@../../example/http/server/posix_main.cpp]
* [@../../example/http/server/reply.cpp]
* [@../../example/http/server/reply.hpp]
* [@../../example/http/server/request.hpp]
* [@../../example/http/server/request_handler.cpp]
* [@../../example/http/server/request_handler.hpp]
* [@../../example/http/server/request_parser.cpp]
* [@../../example/http/server/request_parser.hpp]
* [@../../example/http/server/server.cpp]
* [@../../example/http/server/server.hpp]
* [@../../example/http/server/win_main.cpp]
* [@boost_asio/example/http/server/connection.cpp]
* [@boost_asio/example/http/server/connection.hpp]
* [@boost_asio/example/http/server/connection_manager.cpp]
* [@boost_asio/example/http/server/connection_manager.hpp]
* [@boost_asio/example/http/server/header.hpp]
* [@boost_asio/example/http/server/mime_types.cpp]
* [@boost_asio/example/http/server/mime_types.hpp]
* [@boost_asio/example/http/server/posix_main.cpp]
* [@boost_asio/example/http/server/reply.cpp]
* [@boost_asio/example/http/server/reply.hpp]
* [@boost_asio/example/http/server/request.hpp]
* [@boost_asio/example/http/server/request_handler.cpp]
* [@boost_asio/example/http/server/request_handler.hpp]
* [@boost_asio/example/http/server/request_parser.cpp]
* [@boost_asio/example/http/server/request_parser.hpp]
* [@boost_asio/example/http/server/server.cpp]
* [@boost_asio/example/http/server/server.hpp]
* [@boost_asio/example/http/server/win_main.cpp]
[heading HTTP Server 2]
An HTTP server using an io_service-per-CPU design.
* [@../../example/http/server2/connection.cpp]
* [@../../example/http/server2/connection.hpp]
* [@../../example/http/server2/header.hpp]
* [@../../example/http/server2/io_service_pool.cpp]
* [@../../example/http/server2/io_service_pool.hpp]
* [@../../example/http/server2/mime_types.cpp]
* [@../../example/http/server2/mime_types.hpp]
* [@../../example/http/server2/posix_main.cpp]
* [@../../example/http/server2/reply.cpp]
* [@../../example/http/server2/reply.hpp]
* [@../../example/http/server2/request.hpp]
* [@../../example/http/server2/request_handler.cpp]
* [@../../example/http/server2/request_handler.hpp]
* [@../../example/http/server2/request_parser.cpp]
* [@../../example/http/server2/request_parser.hpp]
* [@../../example/http/server2/server.cpp]
* [@../../example/http/server2/server.hpp]
* [@../../example/http/server2/win_main.cpp]
* [@boost_asio/example/http/server2/connection.cpp]
* [@boost_asio/example/http/server2/connection.hpp]
* [@boost_asio/example/http/server2/header.hpp]
* [@boost_asio/example/http/server2/io_service_pool.cpp]
* [@boost_asio/example/http/server2/io_service_pool.hpp]
* [@boost_asio/example/http/server2/mime_types.cpp]
* [@boost_asio/example/http/server2/mime_types.hpp]
* [@boost_asio/example/http/server2/posix_main.cpp]
* [@boost_asio/example/http/server2/reply.cpp]
* [@boost_asio/example/http/server2/reply.hpp]
* [@boost_asio/example/http/server2/request.hpp]
* [@boost_asio/example/http/server2/request_handler.cpp]
* [@boost_asio/example/http/server2/request_handler.hpp]
* [@boost_asio/example/http/server2/request_parser.cpp]
* [@boost_asio/example/http/server2/request_parser.hpp]
* [@boost_asio/example/http/server2/server.cpp]
* [@boost_asio/example/http/server2/server.hpp]
* [@boost_asio/example/http/server2/win_main.cpp]
[heading HTTP Server 3]
An HTTP server using a single io_service and a thread pool calling `io_service::run()`.
* [@../../example/http/server3/connection.cpp]
* [@../../example/http/server3/connection.hpp]
* [@../../example/http/server3/header.hpp]
* [@../../example/http/server3/mime_types.cpp]
* [@../../example/http/server3/mime_types.hpp]
* [@../../example/http/server3/posix_main.cpp]
* [@../../example/http/server3/reply.cpp]
* [@../../example/http/server3/reply.hpp]
* [@../../example/http/server3/request.hpp]
* [@../../example/http/server3/request_handler.cpp]
* [@../../example/http/server3/request_handler.hpp]
* [@../../example/http/server3/request_parser.cpp]
* [@../../example/http/server3/request_parser.hpp]
* [@../../example/http/server3/server.cpp]
* [@../../example/http/server3/server.hpp]
* [@../../example/http/server3/win_main.cpp]
* [@boost_asio/example/http/server3/connection.cpp]
* [@boost_asio/example/http/server3/connection.hpp]
* [@boost_asio/example/http/server3/header.hpp]
* [@boost_asio/example/http/server3/mime_types.cpp]
* [@boost_asio/example/http/server3/mime_types.hpp]
* [@boost_asio/example/http/server3/posix_main.cpp]
* [@boost_asio/example/http/server3/reply.cpp]
* [@boost_asio/example/http/server3/reply.hpp]
* [@boost_asio/example/http/server3/request.hpp]
* [@boost_asio/example/http/server3/request_handler.cpp]
* [@boost_asio/example/http/server3/request_handler.hpp]
* [@boost_asio/example/http/server3/request_parser.cpp]
* [@boost_asio/example/http/server3/request_parser.hpp]
* [@boost_asio/example/http/server3/server.cpp]
* [@boost_asio/example/http/server3/server.hpp]
* [@boost_asio/example/http/server3/win_main.cpp]
[heading Invocation]
@@ -134,7 +134,7 @@ An HTTP server using a single io_service and a thread pool calling `io_service::
This example shows how to customise handler invocation. Completion handlers are
added to a priority queue rather than executed immediately.
* [@../../example/invocation/prioritised_handlers.cpp]
* [@boost_asio/example/invocation/prioritised_handlers.cpp]
[heading Iostreams]
@@ -142,8 +142,8 @@ added to a priority queue rather than executed immediately.
Two examples showing how to use [link boost_asio.reference.ip__tcp.iostream
ip::tcp::iostream].
* [@../../example/iostreams/daytime_client.cpp]
* [@../../example/iostreams/daytime_server.cpp]
* [@boost_asio/example/iostreams/daytime_client.cpp]
* [@boost_asio/example/iostreams/daytime_server.cpp]
[heading Multicast]
@@ -151,8 +151,8 @@ ip::tcp::iostream].
An example showing the use of multicast to transmit packets to a group of
subscribers.
* [@../../example/multicast/receiver.cpp]
* [@../../example/multicast/sender.cpp]
* [@boost_asio/example/multicast/receiver.cpp]
* [@boost_asio/example/multicast/sender.cpp]
[heading Serialization]
@@ -160,10 +160,10 @@ subscribers.
This example shows how Boost.Serialization can be used with asio to encode and
decode structures for transmission over a socket.
* [@../../example/serialization/client.cpp]
* [@../../example/serialization/connection.hpp]
* [@../../example/serialization/server.cpp]
* [@../../example/serialization/stock.hpp]
* [@boost_asio/example/serialization/client.cpp]
* [@boost_asio/example/serialization/connection.hpp]
* [@boost_asio/example/serialization/server.cpp]
* [@boost_asio/example/serialization/stock.hpp]
[heading Services]
@@ -173,12 +173,12 @@ for logging) into asio's [link boost_asio.reference.io_service io_service], and
how to use a custom service with [link
boost_asio.reference.basic_stream_socket basic_stream_socket<>].
* [@../../example/services/basic_logger.hpp]
* [@../../example/services/daytime_client.cpp]
* [@../../example/services/logger.hpp]
* [@../../example/services/logger_service.cpp]
* [@../../example/services/logger_service.hpp]
* [@../../example/services/stream_socket_service.hpp]
* [@boost_asio/example/services/basic_logger.hpp]
* [@boost_asio/example/services/daytime_client.cpp]
* [@boost_asio/example/services/logger.hpp]
* [@boost_asio/example/services/logger_service.cpp]
* [@boost_asio/example/services/logger_service.hpp]
* [@boost_asio/example/services/stream_socket_service.hpp]
[heading SOCKS 4]
@@ -186,8 +186,8 @@ boost_asio.reference.basic_stream_socket basic_stream_socket<>].
Example client program implementing the SOCKS 4 protocol for communication via
a proxy.
* [@../../example/socks4/sync_client.cpp]
* [@../../example/socks4/socks4.hpp]
* [@boost_asio/example/socks4/sync_client.cpp]
* [@boost_asio/example/socks4/socks4.hpp]
[heading SSL]
@@ -196,8 +196,8 @@ Example client and server programs showing the use of the [link
boost_asio.reference.ssl__stream ssl::stream<>] template with asynchronous
operations.
* [@../../example/ssl/client.cpp]
* [@../../example/ssl/server.cpp]
* [@boost_asio/example/ssl/client.cpp]
* [@boost_asio/example/ssl/server.cpp]
[heading Timeouts]
@@ -205,18 +205,18 @@ operations.
A collection of examples showing how to cancel long running asynchronous
operations after a period of time.
* [@../../example/timeouts/accept_timeout.cpp]
* [@../../example/timeouts/connect_timeout.cpp]
* [@../../example/timeouts/datagram_receive_timeout.cpp]
* [@../../example/timeouts/stream_receive_timeout.cpp]
* [@boost_asio/example/timeouts/accept_timeout.cpp]
* [@boost_asio/example/timeouts/connect_timeout.cpp]
* [@boost_asio/example/timeouts/datagram_receive_timeout.cpp]
* [@boost_asio/example/timeouts/stream_receive_timeout.cpp]
[heading Timers]
Examples showing how to customise deadline_timer using different time types.
* [@../../example/timers/tick_count_timer.cpp]
* [@../../example/timers/time_t_timer.cpp]
* [@boost_asio/example/timers/tick_count_timer.cpp]
* [@boost_asio/example/timers/time_t_timer.cpp]
[endsect]

32
index.html
View File

@@ -1,13 +1,21 @@
<html>
<head>
<meta http-equiv="refresh" content="0; URL=doc/html/index.html">
</head>
<body>
Automatic redirection failed, please go to
<a href="doc/html/index.html">doc/html/index.html</a> &nbsp;<hr>
<p>© Copyright Beman Dawes, 2001</p>
<p>Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</p>
</body>
</html>
<head>
<title>Boost.Asio</title>
<meta http-equiv="refresh" content="0; URL=../../doc/html/boost_asio.html"/>
</head>
<body>
<p>
Automatic redirection failed, please go to
<a href="../../doc/html/boost_asio.html">../../doc/html/boost_asio.html</a>
</p>
<hr/>
<p>
Copyright (c) 2008 Christopher M. Kohlhoff
</p>
<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy at
<a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)
</p>
</body>
</html>