[/
 / Copyright (c) 2003-2024 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:examples Examples]


* [link asio.examples.cpp11_examples C++11 Examples]: Illustrates the use of
Asio using only C++11 language and library features. Where necessary, the
examples make use of selected Boost C++ libraries.

* [link asio.examples.cpp14_examples C++14 Examples]: Contains a limited set of
the C++03 Asio examples, updated to use only C++14 library and language
facilities. These examples do not make direct use of Boost C++ libraries.

* [link asio.examples.cpp17_examples C++17 Examples]: Selected examples
illustrating C++17 usage in conjunction with Technical Specifications.

* [link asio.examples.cpp20_examples C++20 Examples]: Selected examples
using C++20 language features.


[section:cpp11_examples C++11 Examples]


[heading Allocation]

This example shows how to customise the allocation of memory associated with
asynchronous operations.

* [@../src/examples/cpp11/allocation/server.cpp]


[heading Buffers]

This example demonstrates how to create reference counted buffers that can be
used with socket read and write operations.

* [@../src/examples/cpp11/buffers/reference_counted.cpp]


[heading Chat]

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.

* [@../src/examples/cpp11/chat/chat_message.hpp]
* [@../src/examples/cpp11/chat/chat_client.cpp]
* [@../src/examples/cpp11/chat/chat_server.cpp]

The following POSIX-specific chat client demonstrates how to use the
[link asio.reference.posix__stream_descriptor posix::stream_descriptor] class to
perform console input and output.

* [@../src/examples/cpp11/chat/posix_chat_client.cpp]


[heading Deferred]

Examples showing how to use the [link asio.reference.deferred `deferred`]
completion token.

* [@../src/examples/cpp11/deferred/deferred_1.cpp]
* [@../src/examples/cpp11/deferred/deferred_2.cpp]


[heading Echo]

A collection of simple clients and servers, showing the use of both synchronous
and asynchronous operations.

* [@../src/examples/cpp11/echo/async_tcp_echo_server.cpp]
* [@../src/examples/cpp11/echo/async_udp_echo_server.cpp]
* [@../src/examples/cpp11/echo/blocking_tcp_echo_client.cpp]
* [@../src/examples/cpp11/echo/blocking_tcp_echo_server.cpp]
* [@../src/examples/cpp11/echo/blocking_udp_echo_client.cpp]
* [@../src/examples/cpp11/echo/blocking_udp_echo_server.cpp]


[heading Fork]

These POSIX-specific examples show how to use Asio in conjunction with the
`fork()` system call. The first example illustrates the steps required to start
a daemon process:

* [@../src/examples/cpp11/fork/daemon.cpp]

The second example demonstrates how it is possible to fork a process from
within a completion handler.

* [@../src/examples/cpp11/fork/process_per_connection.cpp]


[heading Futures]

This example demonstrates how to use std::future in conjunction with
Asio's asynchronous operations.

* [@../src/examples/cpp11/futures/daytime_client.cpp]


[heading Handler Tracking]

This example header file shows how to implement custom handler tracking.

* [@../src/examples/cpp11/handler_tracking/custom_tracking.hpp]

This example program shows how to include source location information in
the handler tracking output.

* [@../src/examples/cpp11/handler_tracking/async_tcp_echo_server.cpp]


[heading HTTP Client]

Example programs implementing simple HTTP 1.0 clients. These examples show how
to use the [link asio.reference.read_until read_until] and [link
asio.reference.async_read_until async_read_until] functions.

* [@../src/examples/cpp11/http/client/sync_client.cpp]
* [@../src/examples/cpp11/http/client/async_client.cpp]


[heading HTTP Server]

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.

* [@../src/examples/cpp11/http/server/connection.cpp]
* [@../src/examples/cpp11/http/server/connection.hpp]
* [@../src/examples/cpp11/http/server/connection_manager.cpp]
* [@../src/examples/cpp11/http/server/connection_manager.hpp]
* [@../src/examples/cpp11/http/server/header.hpp]
* [@../src/examples/cpp11/http/server/main.cpp]
* [@../src/examples/cpp11/http/server/mime_types.cpp]
* [@../src/examples/cpp11/http/server/mime_types.hpp]
* [@../src/examples/cpp11/http/server/reply.cpp]
* [@../src/examples/cpp11/http/server/reply.hpp]
* [@../src/examples/cpp11/http/server/request.hpp]
* [@../src/examples/cpp11/http/server/request_handler.cpp]
* [@../src/examples/cpp11/http/server/request_handler.hpp]
* [@../src/examples/cpp11/http/server/request_parser.cpp]
* [@../src/examples/cpp11/http/server/request_parser.hpp]
* [@../src/examples/cpp11/http/server/server.cpp]
* [@../src/examples/cpp11/http/server/server.hpp]


[heading HTTP Server 2]

An HTTP server using an io_context-per-CPU design.

* [@../src/examples/cpp11/http/server2/connection.cpp]
* [@../src/examples/cpp11/http/server2/connection.hpp]
* [@../src/examples/cpp11/http/server2/header.hpp]
* [@../src/examples/cpp11/http/server2/io_context_pool.cpp]
* [@../src/examples/cpp11/http/server2/io_context_pool.hpp]
* [@../src/examples/cpp11/http/server2/main.cpp]
* [@../src/examples/cpp11/http/server2/mime_types.cpp]
* [@../src/examples/cpp11/http/server2/mime_types.hpp]
* [@../src/examples/cpp11/http/server2/reply.cpp]
* [@../src/examples/cpp11/http/server2/reply.hpp]
* [@../src/examples/cpp11/http/server2/request.hpp]
* [@../src/examples/cpp11/http/server2/request_handler.cpp]
* [@../src/examples/cpp11/http/server2/request_handler.hpp]
* [@../src/examples/cpp11/http/server2/request_parser.cpp]
* [@../src/examples/cpp11/http/server2/request_parser.hpp]
* [@../src/examples/cpp11/http/server2/server.cpp]
* [@../src/examples/cpp11/http/server2/server.hpp]


[heading HTTP Server 3]

An HTTP server using a single io_context and a thread pool calling `io_context::run()`.

* [@../src/examples/cpp11/http/server3/connection.cpp]
* [@../src/examples/cpp11/http/server3/connection.hpp]
* [@../src/examples/cpp11/http/server3/header.hpp]
* [@../src/examples/cpp11/http/server3/main.cpp]
* [@../src/examples/cpp11/http/server3/mime_types.cpp]
* [@../src/examples/cpp11/http/server3/mime_types.hpp]
* [@../src/examples/cpp11/http/server3/reply.cpp]
* [@../src/examples/cpp11/http/server3/reply.hpp]
* [@../src/examples/cpp11/http/server3/request.hpp]
* [@../src/examples/cpp11/http/server3/request_handler.cpp]
* [@../src/examples/cpp11/http/server3/request_handler.hpp]
* [@../src/examples/cpp11/http/server3/request_parser.cpp]
* [@../src/examples/cpp11/http/server3/request_parser.hpp]
* [@../src/examples/cpp11/http/server3/server.cpp]
* [@../src/examples/cpp11/http/server3/server.hpp]


[heading HTTP Server 4]

A single-threaded HTTP server implemented using stackless coroutines.

* [@../src/examples/cpp11/http/server4/file_handler.cpp]
* [@../src/examples/cpp11/http/server4/file_handler.hpp]
* [@../src/examples/cpp11/http/server4/header.hpp]
* [@../src/examples/cpp11/http/server4/main.cpp]
* [@../src/examples/cpp11/http/server4/mime_types.cpp]
* [@../src/examples/cpp11/http/server4/mime_types.hpp]
* [@../src/examples/cpp11/http/server4/reply.cpp]
* [@../src/examples/cpp11/http/server4/reply.hpp]
* [@../src/examples/cpp11/http/server4/request.hpp]
* [@../src/examples/cpp11/http/server4/request_parser.cpp]
* [@../src/examples/cpp11/http/server4/request_parser.hpp]
* [@../src/examples/cpp11/http/server4/server.cpp]
* [@../src/examples/cpp11/http/server4/server.hpp]


[heading ICMP]

This example shows how to use raw sockets with ICMP to ping a remote host.

* [@../src/examples/cpp11/icmp/ping.cpp]
* [@../src/examples/cpp11/icmp/ipv4_header.hpp]
* [@../src/examples/cpp11/icmp/icmp_header.hpp]


[heading Invocation]

This example shows how to customise handler invocation. Completion handlers are
added to a priority queue rather than executed immediately.

* [@../src/examples/cpp11/invocation/prioritised_handlers.cpp]


[heading Iostreams]

Two examples showing how to use [link asio.reference.ip__tcp.iostream
ip::tcp::iostream].

* [@../src/examples/cpp11/iostreams/daytime_client.cpp]
* [@../src/examples/cpp11/iostreams/daytime_server.cpp]
* [@../src/examples/cpp11/iostreams/http_client.cpp]


[heading Multicast]

An example showing the use of multicast to transmit packets to a group of
subscribers.

* [@../src/examples/cpp11/multicast/receiver.cpp]
* [@../src/examples/cpp11/multicast/sender.cpp]


[heading Nonblocking]

Example demonstrating reactor-style operations for integrating a third-party
library that wants to perform the I/O operations itself.

* [@../src/examples/cpp11/nonblocking/third_party_lib.cpp]


[heading Operations]

Examples showing how to implement composed asynchronous operations as reusable library functions.

* [@../src/examples/cpp11/operations/composed_1.cpp]
* [@../src/examples/cpp11/operations/composed_2.cpp]
* [@../src/examples/cpp11/operations/composed_3.cpp]
* [@../src/examples/cpp11/operations/composed_4.cpp]
* [@../src/examples/cpp11/operations/composed_5.cpp]
* [@../src/examples/cpp11/operations/composed_6.cpp]
* [@../src/examples/cpp11/operations/composed_7.cpp]
* [@../src/examples/cpp11/operations/composed_8.cpp]


[heading Parallel Groups]

Examples showing how to use the [link
asio.reference.experimental__make_parallel_group
`experimental::make_parallel_group`] operation.

* [@../src/examples/cpp11/parallel_group/wait_for_all.cpp]
* [@../src/examples/cpp11/parallel_group/wait_for_one.cpp]
* [@../src/examples/cpp11/parallel_group/wait_for_one_error.cpp]
* [@../src/examples/cpp11/parallel_group/wait_for_one_success.cpp]
* [@../src/examples/cpp11/parallel_group/ranged_wait_for_all.cpp]


[heading Porthopper]

Example illustrating mixed synchronous and asynchronous operations.

* [@../src/examples/cpp11/porthopper/protocol.hpp]
* [@../src/examples/cpp11/porthopper/client.cpp]
* [@../src/examples/cpp11/porthopper/server.cpp]


[heading Serialization]

This example shows how Boost.Serialization can be used with asio to encode and
decode structures for transmission over a socket.

* [@../src/examples/cpp11/serialization/client.cpp]
* [@../src/examples/cpp11/serialization/connection.hpp]
* [@../src/examples/cpp11/serialization/server.cpp]
* [@../src/examples/cpp11/serialization/stock.hpp]


[heading Services]

This example demonstrates how to integrate custom functionality (in this case,
for logging) into asio's [link asio.reference.io_context io_context], and
how to use a custom service with [link
asio.reference.basic_stream_socket basic_stream_socket<>].

* [@../src/examples/cpp11/services/basic_logger.hpp]
* [@../src/examples/cpp11/services/daytime_client.cpp]
* [@../src/examples/cpp11/services/logger.hpp]
* [@../src/examples/cpp11/services/logger_service.cpp]
* [@../src/examples/cpp11/services/logger_service.hpp]
* [@../src/examples/cpp11/services/stream_socket_service.hpp]


[heading SOCKS 4]

Example client program implementing the SOCKS 4 protocol for communication via
a proxy.

* [@../src/examples/cpp11/socks4/sync_client.cpp]
* [@../src/examples/cpp11/socks4/socks4.hpp]


[heading Spawn]

Example of using the asio::spawn() function, a wrapper around the
[@http://www.boost.org/doc/libs/release/libs/context/index.html Boost.Context]
library, to implement a chain of asynchronous operations using stackful
coroutines.

* [@../src/examples/cpp11/spawn/echo_server.cpp]


[heading SSL]

Example client and server programs showing the use of the [link
asio.reference.ssl__stream ssl::stream<>] template with asynchronous operations.

* [@../src/examples/cpp11/ssl/client.cpp]
* [@../src/examples/cpp11/ssl/server.cpp]


[heading Timeouts]

A collection of examples showing how to cancel long running asynchronous
operations after a period of time.

* [@../src/examples/cpp11/timeouts/async_tcp_client.cpp]
* [@../src/examples/cpp11/timeouts/blocking_tcp_client.cpp]
* [@../src/examples/cpp11/timeouts/blocking_token_tcp_client.cpp]
* [@../src/examples/cpp11/timeouts/blocking_udp_client.cpp]
* [@../src/examples/cpp11/timeouts/server.cpp]


[heading Timers]

Example showing how to customise basic_waitable_timer using a different clock type.

* [@../src/examples/cpp11/timers/time_t_timer.cpp]


[heading Type Erasure]

Example showing how to use [link asio.reference.any_completion_handler
`any_completion_handler`] to enable separate compilation of asynchronous
operations.

* [@../src/examples/cpp11/type_erasure/main.cpp]
* [@../src/examples/cpp11/type_erasure/line_reader.hpp]
* [@../src/examples/cpp11/type_erasure/stdin_line_reader.hpp]
* [@../src/examples/cpp11/type_erasure/stdin_line_reader.cpp]
* [@../src/examples/cpp11/type_erasure/sleep.hpp]
* [@../src/examples/cpp11/type_erasure/sleep.cpp]


[heading UNIX Domain Sockets]

Examples showing how to use UNIX domain (local) sockets.

* [@../src/examples/cpp11/local/connect_pair.cpp]
* [@../src/examples/cpp11/local/iostream_client.cpp]
* [@../src/examples/cpp11/local/stream_server.cpp]
* [@../src/examples/cpp11/local/stream_client.cpp]
* [@../src/examples/cpp11/local/fd_passing_stream_server.cpp]
* [@../src/examples/cpp11/local/fd_passing_stream_client.cpp]


[heading Windows]

An example showing how to use the Windows-specific function `TransmitFile`
with Asio.

* [@../src/examples/cpp11/windows/transmit_file.cpp]


[endsect]


[section:cpp14_examples C++14 Examples]


[heading Deferred]

Examples showing how to use the [link asio.reference.deferred `deferred`]
completion token.

* [@../src/examples/cpp14/deferred/deferred_1.cpp]
* [@../src/examples/cpp14/deferred/deferred_2.cpp]
* [@../src/examples/cpp14/deferred/deferred_3.cpp]
* [@../src/examples/cpp14/deferred/deferred_4.cpp]
* [@../src/examples/cpp14/deferred/deferred_5.cpp]
* [@../src/examples/cpp14/deferred/deferred_6.cpp]
* [@../src/examples/cpp14/deferred/deferred_7.cpp]


[heading Echo]

A collection of simple clients and servers, showing the use of both synchronous
and asynchronous operations.

* [@../src/examples/cpp14/echo/async_tcp_echo_server.cpp]
* [@../src/examples/cpp14/echo/async_udp_echo_server.cpp]
* [@../src/examples/cpp14/echo/blocking_tcp_echo_client.cpp]
* [@../src/examples/cpp14/echo/blocking_tcp_echo_server.cpp]
* [@../src/examples/cpp14/echo/blocking_udp_echo_client.cpp]
* [@../src/examples/cpp14/echo/blocking_udp_echo_server.cpp]


[heading Executors]

Examples showing how to use the executor-related facilities.

* [@../src/examples/cpp14/executors/actor.cpp]
* [@../src/examples/cpp14/executors/async_1.cpp]
* [@../src/examples/cpp14/executors/async_2.cpp]
* [@../src/examples/cpp14/executors/bank_account_1.cpp]
* [@../src/examples/cpp14/executors/bank_account_2.cpp]
* [@../src/examples/cpp14/executors/fork_join.cpp]
* [@../src/examples/cpp14/executors/pipeline.cpp]
* [@../src/examples/cpp14/executors/priority_scheduler.cpp]


[heading Iostreams]

Two examples showing how to use [link asio.reference.ip__tcp.iostream
ip::tcp::iostream].

* [@../src/examples/cpp14/iostreams/http_client.cpp]


[heading Operations]

Examples showing how to implement composed asynchronous operations as reusable library functions.

* [@../src/examples/cpp14/operations/composed_1.cpp]
* [@../src/examples/cpp14/operations/composed_2.cpp]
* [@../src/examples/cpp14/operations/composed_3.cpp]
* [@../src/examples/cpp14/operations/composed_4.cpp]
* [@../src/examples/cpp14/operations/composed_5.cpp]
* [@../src/examples/cpp14/operations/composed_6.cpp]
* [@../src/examples/cpp14/operations/composed_7.cpp]
* [@../src/examples/cpp14/operations/composed_8.cpp]

Examples showing how to expose callback-based APIs as asynchronous operations.

* [@../src/examples/cpp14/operations/callback_wrapper.cpp]
* [@../src/examples/cpp14/operations/c_callback_wrapper.cpp]


[heading Parallel Groups]

Examples showing how to use the [link
asio.reference.experimental__make_parallel_group
`experimental::make_parallel_group`] operation.

* [@../src/examples/cpp14/parallel_group/parallel_sort.cpp]
* [@../src/examples/cpp14/parallel_group/wait_for_all.cpp]
* [@../src/examples/cpp14/parallel_group/wait_for_one.cpp]
* [@../src/examples/cpp14/parallel_group/wait_for_one_error.cpp]
* [@../src/examples/cpp14/parallel_group/wait_for_one_success.cpp]
* [@../src/examples/cpp14/parallel_group/ranged_wait_for_all.cpp]


[endsect]


[section:cpp17_examples C++17 Examples]


[heading Coroutines TS Support]

Examples showing how to implement a chain of asynchronous operations using the
Coroutines TS.

* [@../src/examples/cpp17/coroutines_ts/echo_server.cpp]
* [@../src/examples/cpp17/coroutines_ts/refactored_echo_server.cpp]
* [@../src/examples/cpp17/coroutines_ts/chat_server.cpp]
* [@../src/examples/cpp17/coroutines_ts/range_based_for.cpp]


[endsect]


[section:cpp20_examples C++20 Examples]


[heading Channels]

Example showing how to use a channel in conjunction with C++20 coroutines.

* [@../src/examples/cpp20/channels/mutual_exclusion_1.cpp]
* [@../src/examples/cpp20/channels/mutual_exclusion_2.cpp]
* [@../src/examples/cpp20/channels/throttling_proxy.cpp]


[heading Coroutines]

Examples showing how to implement a chain of asynchronous operations using C++20
Coroutines.

* [@../src/examples/cpp20/coroutines/echo_server.cpp]
* [@../src/examples/cpp20/coroutines/echo_server_with_default.cpp]
* [@../src/examples/cpp20/coroutines/echo_server_with_as_tuple_default.cpp]
* [@../src/examples/cpp20/coroutines/echo_server_with_as_single_default.cpp]
* [@../src/examples/cpp20/coroutines/echo_server_with_deferred.cpp]
* [@../src/examples/cpp20/coroutines/echo_server_with_deferred_default.cpp]
* [@../src/examples/cpp20/coroutines/refactored_echo_server.cpp]
* [@../src/examples/cpp20/coroutines/chat_server.cpp]
* [@../src/examples/cpp20/coroutines/timeout.cpp]


[heading Invocation]

This example shows how to customise handler invocation using a user-defined
completion executor.

* [@../src/examples/cpp20/invocation/completion_executor.cpp]


[heading Operations]

Examples showing how to implement composed asynchronous operations as reusable library functions.

* [@../src/examples/cpp20/operations/composed_1.cpp]
* [@../src/examples/cpp20/operations/composed_2.cpp]
* [@../src/examples/cpp20/operations/composed_3.cpp]
* [@../src/examples/cpp20/operations/composed_4.cpp]
* [@../src/examples/cpp20/operations/composed_5.cpp]
* [@../src/examples/cpp20/operations/composed_6.cpp]
* [@../src/examples/cpp20/operations/composed_7.cpp]
* [@../src/examples/cpp20/operations/composed_8.cpp]

Examples showing how to expose callback-based APIs as asynchronous operations.

* [@../src/examples/cpp20/operations/callback_wrapper.cpp]
* [@../src/examples/cpp20/operations/c_callback_wrapper.cpp]


[heading Type Erasure]

Example showing how to use [link asio.reference.any_completion_handler
`any_completion_handler`] to enable separate compilation of asynchronous
operations.

* [@../src/examples/cpp20/type_erasure/main.cpp]
* [@../src/examples/cpp20/type_erasure/line_reader.hpp]
* [@../src/examples/cpp20/type_erasure/stdin_line_reader.hpp]
* [@../src/examples/cpp20/type_erasure/stdin_line_reader.cpp]
* [@../src/examples/cpp20/type_erasure/sleep.hpp]
* [@../src/examples/cpp20/type_erasure/sleep.cpp]


[endsect]


[endsect]
