boost::corosio

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.

Description

For an inline (zero‐overhead) alternative that includes platform headers, use <boost/corosio/native/native_socket_option.hpp> (boost::corosio::native_socket_option).

Both variants satisfy the same option‐type interface and work interchangeably with tcp_socket::set_option / tcp_socket::get_option and the corresponding acceptor methods.

Namespaces

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.

Types

Name

Description

endpoint

An IP endpoint (address + port) supporting both IPv4 and IPv6.

epoll_t

Backend tag for the Linux epoll I/O multiplexer.

io_buffer_param

A type‐erased buffer sequence for I/O system call boundaries.

io_context

An I/O context for running asynchronous operations.

io_object

Base class for platform I/O objects.

io_read_stream

Abstract base for streams that support async reads.

io_signal_set

Abstract base for asynchronous signal sets.

io_stream

Platform stream with read/write operations.

io_timer

Abstract base for asynchronous timers.

io_write_stream

Abstract base for streams that support async writes.

ipv4_address

An IP version 4 style address.

ipv6_address

An IP version 6 style address.

native_io_context

An I/O context with devirtualized event loop methods.

native_resolver

An asynchronous DNS resolver with devirtualized operations.

native_signal_set

An asynchronous signal set with devirtualized wait operations.

native_tcp_acceptor

An asynchronous TCP acceptor with devirtualized accept operations.

native_tcp_socket

An asynchronous TCP socket with devirtualized I/O operations.

native_timer

An asynchronous timer with devirtualized wait operations.

openssl_stream

A TLS stream using OpenSSL.

resolver

An asynchronous DNS resolver for coroutine I/O.

resolver_entry

A single entry produced by a resolver.

resolver_results

A range of entries produced by a resolver.

reverse_resolver_result

The result of a reverse DNS resolution.

select_t

Backend tag for the portable select() I/O multiplexer.

signal_set

An asynchronous signal set for coroutine I/O.

tcp

Encapsulate the TCP protocol for socket creation.

tcp_acceptor

An asynchronous TCP acceptor for coroutine I/O.

tcp_server

TCP server with pooled workers.

tcp_socket

An asynchronous TCP socket for coroutine I/O.

timer

An asynchronous timer for coroutine I/O.

tls_context

tls_stream

Abstract base class for TLS streams.

wolfssl_stream

A TLS stream using WolfSSL.

native_handle_type

Enums

Name

Description

endpoint_format

Endpoint format detection result.

resolve_flags

Bitmask flags for resolver queries.

reverse_flags

Bitmask flags for reverse resolver queries.

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.

Functions

Name

Description

cancel_after

Cancel an operation if it does not complete within a duration.

cancel_at

Cancel an operation if it does not complete by a deadline.

detect_endpoint_format

Detect the format of an endpoint string.

operator&

Bitwise conjunction operators

operator&=

Bitwise conjunction assignment operators

operator|

Bitwise disjunction operators

operator|=

Bitwise disjunction assignment operators

operator~

Bitwise NOT (complement).

parse_endpoint

Parse an endpoint from a string.

parse_ipv4_address

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

parse_ipv6_address

Parse a string containing an IPv6 address.

operator<<

Format the address to an output stream.

operator==

Equality operators

operator!=

Inequality operators

Variables

Name

Description

epoll

Tag value for selecting the epoll backend.

select

Tag value for selecting the select backend.

See Also

native_socket_option

Created with MrDocs