boost::corosio

Name

Description

socket_option

Type‐erased socket option types that avoid platform‐specific headers. The protocol level and option name for each type are resolved at link time via the compiled library.

Name

Description

buffer_param

Erases a buffer sequence to the pointer and length a system call takes.

clock_delay_awaitable

Suspends the calling coroutine until Clock::now() reaches the deadline or the environment's stop token is activated. The wait is a sequence of steady‐clock timer waits. After each expiry the clock is re‐read. If the deadline is unreached, the same frame‐embedded waiter is re‐published for the next Traits::to_wait_duration cap. That re‐publish neither resumes the coroutine nor allocates.

delay_awaitable

Suspends the calling coroutine until the deadline elapses or the environment's stop token is activated, whichever comes first. A deadline already elapsed at suspension, or a stop token already active, resumes the coroutine inline, without starting a timer (see Cancellation below). Otherwise the coroutine resumes through the executor once the timer fires or a mid‐wait cancellation arrives.

endpoint

Pairs an IP address with a port for either IPv4 or IPv6.

endpoint_name

The name of an endpoint.

epoll_t

Selects the Linux epoll I/O multiplexer as the backend.

file_base

Groups the flag and seek‐origin constants shared by stream_file and random_access_file.

io_context

Runs asynchronous operations and owns the I/O backend that drives them.

io_context_options

Configures scheduler and reactor tuning for an io_context.

io_object

Owns the platform‐specific handle and execution context that a derived socket, timer, signal handler, or acceptor type uses to dispatch operations.

io_read_stream

Reads bytes from a stream asynchronously.

io_signal_set

Delivers a registered signal to the waiting coroutine.

io_stream

Reads and writes bytes through a platform I/O backend.

io_write_stream

Writes bytes to a stream asynchronously.

iocp_t

Selects the Windows I/O Completion Ports multiplexer as the backend.

ip_address

A version‐independent IP address.

ipv4_address

Stores and parses an IP version 4 address.

ipv6_address

An IP version 6 style address.

kqueue_t

Selects the BSD kqueue I/O multiplexer as the backend.

local_datagram_socket

Sends and receives datagrams over a Unix domain socket, from a coroutine.

local_endpoint

Holds the filesystem path that names a Unix domain socket.

local_stream_acceptor

Accepts inbound Unix domain stream connections, from a coroutine.

local_stream_socket

Reads and writes a Unix domain stream, from a coroutine.

native_io_context

Runs asynchronous operations, calling the backend event loop directly.

native_local_datagram_socket

Sends and receives Unix domain datagrams, calling the backend directly.

native_local_stream_acceptor

Accepts Unix domain stream connections, calling the backend directly.

native_local_stream_socket

Reads and writes a Unix domain stream, calling the backend directly.

native_posix_descriptor

Drives an already‐open POSIX descriptor, calling the backend directly.

native_random_access_file

Reads and writes a file at arbitrary offsets, calling the backend directly.

native_resolver

Resolves host names to endpoints, calling the backend directly.

native_signal_set

Waits for a registered signal, calling the backend directly.

native_stream_file

Reads and writes a file sequentially, calling the backend directly.

native_tcp_acceptor

Accepts TCP connections, calling the backend directly.

native_tcp_socket

Connects, reads, and writes over TCP, calling the backend directly.

native_udp_socket

Sends and receives UDP datagrams, calling the backend directly.

openssl_stream

Encrypts and decrypts a stream using OpenSSL.

posix_descriptor

Drives an already‐open POSIX descriptor from an io_context.

random_access_file

Reads and writes a file at arbitrary offsets, from a coroutine.

resolver

Resolves host names and services to endpoints, from a coroutine.

select_t

Selects the portable select() I/O multiplexer as the backend.

signal_set

Waits from a coroutine for one of a registered set of signals.

stream_file

Reads and writes a file sequentially, from a coroutine.

tcp_acceptor

Accepts inbound TCP connections, from a coroutine.

tcp_server

Manages a pool of reusable workers that handle incoming TCP connections.

tcp_socket

Connects, reads, and writes over TCP, from a coroutine.

tls_context

Configures the certificates, keys, and protocol settings a TLS stream uses.

tls_stream

Reads, writes, and manages the handshake lifecycle of a TLS session over an underlying stream.

udp_socket

Sends and receives datagrams over UDP, from a coroutine.

uring_t

Selects the Linux io_uring proactor as the backend.

verify_context

Exposes the certificate and error state to a verification callback.

wait_traits

Controls how much of the remaining time a single underlying steady‐clock wait may cover before Clock::now() is re‐read. A larger value costs fewer wakeups; a smaller value bounds how late an adjustment of Clock ( e.g. a stepped time‐of‐day clock ) is observed. The default covers the full remaining duration, which is exact for clocks that advance in lockstep with the machine's monotonic clock.

wolfssl_stream

Encrypts and decrypts a stream using WolfSSL.

Name

Description

native_handle_type

Represent a platform‐specific socket descriptor (int on POSIX, SOCKET on Windows).

Name

Description

bind_option

Controls whether local_stream_acceptor::bind() unlinks an existing socket path before binding.

endpoint_format

Identifies which of the four supported endpoint string formats a string is in.

family

The address family of an IP socket or address.

locking_mode

Selects which internal locks the scheduler and reactor elide, trading thread‐safety guarantees for reduced synchronization overhead.

message_flags

Flags for datagram send/`recv` operations.

resolve_flags

Bitmask flags for resolver queries.

reverse_flags

Bitmask flags for reverse resolver queries.

shutdown_type

Different ways a socket may be shutdown.

tls_file_format

Certificate and key file format.

tls_password_purpose

Purpose for password callback invocation.

tls_revocation_policy

Certificate revocation checking policy.

tls_role

TLS handshake role.

tls_verify_mode

Peer certificate verification mode.

tls_version

TLS protocol version.

wait_type

Direction selector for socket and acceptor wait() operations.

Name

Description

connect

connect overloads

connect_pair

connect_pair overloads

delay

delay overloads

detect_endpoint_format

Detect the format of an endpoint string.

host_name

Return the local machine's hostname.

make_endpoint

Create an endpoint from a string.

make_ip_address

Create an IP address from a string.

make_ipv4_address

Create an IPv4 address from an IP address string in dotted decimal form.

make_ipv6_address

Create an IPv6 address from a string.

openssl_category

Return the error category for raw OpenSSL errors.

operator&

Bitwise conjunction operators

operator&=

Bitwise conjunction assignment operators

operator<<

Stream insertion operators

operator<=>

Three‐way comparison operators

operator==

Equality operators

operator|

Bitwise disjunction operators

operator|=

Bitwise disjunction assignment operators

operator~

Bitwise negation operators

timeout

timeout overloads

wolfssl_category

Return the error category for raw WolfSSL errors.

wolfssl_supports_alpn

Report whether this WolfSSL build can negotiate ALPN.

wolfssl_supports_crl

Report whether this WolfSSL build can check certificate revocation.

wolfssl_supports_ip_alt_name

Report whether this WolfSSL build can verify IP‐literal hostnames.

wolfssl_supports_verify_callback

Report whether this build's WolfSSL can honor a verify callback.

Name

Description

epoll

Tag value for selecting the epoll backend.

iocp

Tag value for selecting the IOCP backend.

kqueue

Tag value for selecting the kqueue backend.

select

Tag value for selecting the select backend.

uring

Tag value for selecting the io_uring backend.

Name

Description

WaitTraits

Concept for wait‐traits policies usable with Clock.