Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/3.tutorials/3a.echo-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ This tutorial builds a production-quality echo server using the `tcp_server`
framework. We'll explore worker pools, connection lifecycle, and the launcher
pattern.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/tcp_server.hpp>
Expand All @@ -23,6 +25,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/3.tutorials/3b.http-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ This tutorial builds a simple HTTP client that connects to a server, sends
a GET request, and reads the response. You'll learn socket connection,
composed I/O operations, and the exception-based error handling pattern.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio.hpp>
Expand All @@ -26,6 +28,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/3.tutorials/3c.dns-lookup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ This tutorial builds a command-line DNS lookup tool similar to `nslookup`.
You'll learn to use the asynchronous resolver to convert hostnames to IP
addresses.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio.hpp>
Expand All @@ -23,6 +25,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/3.tutorials/3d.tls-context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,16 @@ This tutorial covers how to configure TLS contexts for secure connections.
A `tls_context` stores certificates, keys, and settings that define how
TLS connections are established and verified.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/tls_context.hpp>

namespace tls = boost::corosio::tls;
----
====

== Introduction

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4c.io-context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ The `io_context` class is the heart of Corosio. It's an event loop that
processes asynchronous I/O operations, manages timers, and coordinates
coroutine execution.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/io_context.hpp>
namespace corosio = boost::corosio;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4d.sockets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ The `tcp_socket` class provides asynchronous TCP networking. It supports
connecting to servers, reading and writing data, and graceful connection
management.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/tcp_socket.hpp>
Expand All @@ -23,6 +25,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4e.tcp-acceptor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
The `tcp_acceptor` class listens for incoming TCP connections and accepts them
into socket objects. It's the foundation for building TCP servers.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/tcp_acceptor.hpp>
Expand All @@ -21,6 +23,7 @@ NOTE: Code snippets assume:

namespace corosio = boost::corosio;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4f.endpoints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ The `endpoint` class represents a network endpoint: an IP address (IPv4 or
IPv6) combined with a port number. Endpoints are used for connecting sockets
and binding acceptors.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/endpoint.hpp>
Expand All @@ -22,6 +24,7 @@ NOTE: Code snippets assume:

namespace corosio = boost::corosio;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4g.composed-operations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
Corosio provides composed operations that build on the primitive `read_some()`
and `write_some()` functions to provide higher-level guarantees.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/read.hpp>
Expand All @@ -22,6 +24,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== The Problem with Primitives

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4h.timers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,16 @@ The `timer` class provides asynchronous delays and timeouts. It integrates
with the I/O context to schedule operations at specific times or after
durations.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/timer.hpp>
namespace corosio = boost::corosio;
using namespace std::chrono_literals;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4i.signals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,17 @@ The `signal_set` class provides asynchronous signal handling. It allows
coroutines to wait for operating system signals like SIGINT (Ctrl+C) or
SIGTERM.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/signal_set.hpp>
#include <csignal>

namespace corosio = boost::corosio;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4j.resolver.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ The `resolver` class performs asynchronous DNS lookups, converting hostnames
to IP addresses. It wraps the system's `getaddrinfo()` function with an
asynchronous interface.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/resolver.hpp>
namespace corosio = boost::corosio;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4k.tcp-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ The `tcp_server` class provides a framework for building TCP servers with
connection pooling. It manages acceptors, worker pools, and connection
lifecycle automatically.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/tcp_server.hpp>
Expand All @@ -23,6 +25,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4l.tls.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ Corosio provides TLS encryption through the `tls_context` configuration class
and stream wrappers that add encryption to existing connections. This chapter
covers context configuration, stream usage, and common TLS patterns.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/tls_context.hpp>
Expand All @@ -23,6 +25,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace tls = corosio::tls;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4m.error-handling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
Corosio provides flexible error handling through the `io_result` type, which
supports both error-code and exception-based patterns.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio.hpp>
Expand All @@ -22,6 +24,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== The io_result Type

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/4.guide/4n.buffers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@
Corosio I/O operations work with buffer sequences from Boost.Capy. This page
explains how to use buffers effectively.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/capy/buffers.hpp>
namespace capy = boost::capy;
----
====

== Buffer Types

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/5.testing/5a.mocket.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ The `mocket` class provides mock sockets for testing I/O code without
actual network operations. Mockets let you stage data for reading and
verify expected writes.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/test/mocket.hpp>
Expand All @@ -22,6 +24,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/quick-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ This guide walks you through building your first network application with
Corosio: a simple echo server that accepts connections and echoes back
whatever clients send.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/tcp_server.hpp>
Expand All @@ -23,6 +25,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Step 1: Create the I/O Context

Expand Down
Loading