overview.qbk 7.93 KB
[/
 / Copyright (c) 2003-2022 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:overview Overview]

* [link boost_asio.overview.rationale Rationale]
* [link boost_asio.overview.basics Basic Boost.Asio Anatomy]
* [link boost_asio.overview.model Asynchronous Model]
  * [link boost_asio.overview.model.async_ops Asynchronous Operations]
  * [link boost_asio.overview.model.async_agents Asynchronous Agents]
  * [link boost_asio.overview.model.associators Associated Characteristics and Associators]
  * [link boost_asio.overview.model.child_agents Child Agents]
  * [link boost_asio.overview.model.executors Executors]
  * [link boost_asio.overview.model.allocators Allocators]
  * [link boost_asio.overview.model.cancellation Cancellation]
  * [link boost_asio.overview.model.completion_tokens Completion Tokens]
  * [link boost_asio.overview.model.library_elements Supporting Library Elements]
  * [link boost_asio.overview.model.higher_levels Higher Level Abstractions]
* [link boost_asio.overview.core Core Concepts and Functionality]
  * [link boost_asio.overview.core.async The Proactor Design Pattern: Concurrency Without Threads]
  * [link boost_asio.overview.core.threads Threads and Boost.Asio]
  * [link boost_asio.overview.core.strands Strands: Use Threads Without Explicit Locking]
  * [link boost_asio.overview.core.buffers Buffers]
  * [link boost_asio.overview.core.streams Streams, Short Reads and Short Writes]
  * [link boost_asio.overview.core.reactor Reactor-Style Operations]
  * [link boost_asio.overview.core.line_based Line-Based Operations]
  * [link boost_asio.overview.core.allocation Custom Memory Allocation]
  * [link boost_asio.overview.core.cancellation Per-Operation Cancellation]
  * [link boost_asio.overview.core.handler_tracking Handler Tracking]
  * [link boost_asio.overview.core.concurrency_hint Concurrency Hints]
* [link boost_asio.overview.composition Composition and Completion Tokens]
  * [link boost_asio.overview.composition.coroutine Stackless Coroutines]
  * [link boost_asio.overview.composition.spawn Stackful Coroutines]
  * [link boost_asio.overview.composition.futures Futures]
  * [link boost_asio.overview.composition.cpp20_coroutines C++20 Coroutines Support]
  * [link boost_asio.overview.composition.coro Resumable C++20 Coroutines (experimental)]
  * [link boost_asio.overview.composition.deferred Deferred Operations (experimental)]
  * [link boost_asio.overview.composition.promises Promises (experimental)]
  * [link boost_asio.overview.composition.parallel_group Co-ordinating Parallel Operations (experimental)]
  * [link boost_asio.overview.composition.compose Compositions as Asynchronous Operations]
  * [link boost_asio.overview.composition.token_adapters Completion Token Adapters]
* [link boost_asio.overview.networking Networking]
  * [link boost_asio.overview.networking.protocols TCP, UDP and ICMP]
  * [link boost_asio.overview.networking.other_protocols Support for Other Protocols]
  * [link boost_asio.overview.networking.iostreams Socket Iostreams]
  * [link boost_asio.overview.networking.bsd_sockets The BSD Socket API and Boost.Asio]
* [link boost_asio.overview.timers Timers]
* [link boost_asio.overview.files Files]
* [link boost_asio.overview.pipes Pipes]
* [link boost_asio.overview.serial_ports Serial Ports]
* [link boost_asio.overview.signals Signal Handling]
* [link boost_asio.overview.channels Channels (experimental)]
* [link boost_asio.overview.posix POSIX-Specific Functionality]
  * [link boost_asio.overview.posix.local UNIX Domain Sockets]
  * [link boost_asio.overview.posix.stream_descriptor Stream-Oriented File Descriptors]
  * [link boost_asio.overview.posix.fork Fork]
* [link boost_asio.overview.windows Windows-Specific Functionality]
  * [link boost_asio.overview.windows.stream_handle Stream-Oriented HANDLEs]
  * [link boost_asio.overview.windows.random_access_handle Random-Access HANDLEs]
  * [link boost_asio.overview.windows.object_handle Object HANDLEs]
* [link boost_asio.overview.ssl SSL]
* [link boost_asio.overview.cpp2011 C++ 2011 Support]
  * [link boost_asio.overview.cpp2011.move_objects Movable I/O Objects]
  * [link boost_asio.overview.cpp2011.move_handlers Movable Handlers]
  * [link boost_asio.overview.cpp2011.variadic Variadic Templates]
  * [link boost_asio.overview.cpp2011.array Array Container]
  * [link boost_asio.overview.cpp2011.atomic Atomics]
  * [link boost_asio.overview.cpp2011.shared_ptr Shared Pointers]
  * [link boost_asio.overview.cpp2011.chrono Chrono]
* [link boost_asio.overview.implementation Platform-Specific Implementation Notes]

[include overview/rationale.qbk]
[include overview/basics.qbk]
[include overview/model.qbk]

[section:core Core Concepts and Functionality]

* [link boost_asio.overview.core.async The Proactor Design Pattern: Concurrency Without Threads]
* [link boost_asio.overview.core.threads Threads and Boost.Asio]
* [link boost_asio.overview.core.strands Strands: Use Threads Without Explicit Locking]
* [link boost_asio.overview.core.buffers Buffers]
* [link boost_asio.overview.core.streams Streams, Short Reads and Short Writes]
* [link boost_asio.overview.core.reactor Reactor-Style Operations]
* [link boost_asio.overview.core.line_based Line-Based Operations]
* [link boost_asio.overview.core.allocation Custom Memory Allocation]
* [link boost_asio.overview.core.cancellation Per-Operation Cancellation]
* [link boost_asio.overview.core.handler_tracking Handler Tracking]
* [link boost_asio.overview.core.concurrency_hint Concurrency Hints]

[include overview/async.qbk]
[include overview/threads.qbk]
[include overview/strands.qbk]
[include overview/buffers.qbk]
[include overview/streams.qbk]
[include overview/reactor.qbk]
[include overview/line_based.qbk]
[include overview/allocation.qbk]
[include overview/cancellation.qbk]
[include overview/handler_tracking.qbk]
[include overview/concurrency_hint.qbk]

[endsect]

[section:composition Composition and Completion Tokens]

* [link boost_asio.overview.composition.coroutine Stackless Coroutines]
* [link boost_asio.overview.composition.spawn Stackful Coroutines]
* [link boost_asio.overview.composition.futures Futures]
* [link boost_asio.overview.composition.cpp20_coroutines C++20 Coroutines Support]
* [link boost_asio.overview.composition.coro Resumable C++20 Coroutines (experimental)]
* [link boost_asio.overview.composition.deferred Deferred Operations (experimental)]
* [link boost_asio.overview.composition.promises Promises (experimental)]
* [link boost_asio.overview.composition.parallel_group Co-ordinating Parallel Operations (experimental)]
* [link boost_asio.overview.composition.compose Compositions as Asynchronous Operations]
* [link boost_asio.overview.composition.token_adapters Completion Token Adapters]

[include overview/coroutine.qbk]
[include overview/spawn.qbk]
[include overview/futures.qbk]
[include overview/cpp20_coroutines.qbk]
[include overview/coro.qbk]
[include overview/deferred.qbk]
[include overview/promises.qbk]
[include overview/parallel_group.qbk]
[include overview/compose.qbk]
[include overview/token_adapters.qbk]

[endsect]

[section:networking Networking]

* [link boost_asio.overview.networking.protocols TCP, UDP and ICMP]
* [link boost_asio.overview.networking.other_protocols Support for Other Protocols]
* [link boost_asio.overview.networking.iostreams Socket Iostreams]
* [link boost_asio.overview.networking.bsd_sockets The BSD Socket API and Boost.Asio]

[include overview/protocols.qbk]
[include overview/other_protocols.qbk]
[include overview/iostreams.qbk]
[include overview/bsd_sockets.qbk]

[endsect]

[include overview/timers.qbk]
[include overview/files.qbk]
[include overview/pipes.qbk]
[include overview/serial_ports.qbk]
[include overview/signals.qbk]
[include overview/channels.qbk]
[include overview/posix.qbk]
[include overview/windows.qbk]
[include overview/ssl.qbk]
[include overview/cpp2011.qbk]
[include overview/implementation.qbk]

[endsect]