Global namespace
boost::asio namespace
Types
Name |
Description |
A call wrapper type to bind an allocator of type |
|
Polymorphic executor type for use with I/O objects. |
|
Polymorphic wrapper for completion handlers. |
|
An allocator type that forwards memory allocation operations through an instance of |
|
|
A protoco‐allocator type that may be rebound to obtain an allocator that forwards memory allocation operations through an instance of |
Polymorphic executor type for use with I/O objects. |
|
Completion token type used to specify that the completion handler arguments should be passed additional values after the results of the operation. |
|
A |
|
Traits type used to obtain the allocator associated with an object. |
|
|
Specialisation of associated_allocator for |
|
|
Traits type used to obtain the cancellation_slot associated with an object. |
|
|
Specialisation of associated_cancellation_slot for |
Traits type used to obtain the executor associated with an object. |
|
|
Specialisation of associated_executor for |
|
|
Traits type used to obtain the immediate executor associated with an object. |
|
|
Specialisation of associated_immediate_executor for |
Used to generically specialise associators for a type. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Helper template to deduce the handler type from a CompletionToken, capture a local copy of the handler, and then create an async_result for the handler. |
|
|
|
|
|
|
|
|
|
|
|
|
|
The return type of a coroutine or asynchronous operation. |
|
Exception thrown when trying to access an empty polymorphic executor. |
|
Provides datagram‐oriented socket functionality. |
|
Provides file functionality. |
|
Provides random‐access file functionality. |
|
Provides raw‐oriented socket functionality. |
|
Provides pipe functionality. |
|
Provides sequenced packet socket functionality. |
|
Provides serial port functionality. |
|
Provides signal functionality. |
|
Provides socket functionality. |
|
Provides the ability to accept new connections. |
|
Provides stream‐oriented file functionality. |
|
Provides stream‐oriented socket functionality. |
|
An executor that uses arbitrary threads. |
|
Provides waitable timer functionality. |
|
Provides pipe functionality. |
|
Automatically registers and unregistered buffers with an execution context. |
|
Adds buffering to the read‐related operations of a stream. |
|
Adds buffering to the read‐ and write‐related operations of a stream. |
|
Adds buffering to the write‐related operations of a stream. |
|
A random access iterator over the bytes in a buffer sequence. |
|
A |
|
A |
|
A |
|
A |
|
A simple cancellation signal propagation filter. |
|
A cancellation signal with a single slot. |
|
A slot associated with a cancellation signal. |
|
A call wrapper type to bind a cancellation slot of type |
|
A cancellation state is used for chaining signals and slots in compositions. |
|
Provides access to the configuration values associated with an execution context. |
|
Configures an execution context based on a concurrency hint. |
|
Configures an execution context by reading environment variables. |
|
Configures an execution context by reading variables from a string. |
|
Base class for configuration implementations. |
|
Completion token type used to specify that the completion handler should carry additional values along with it. |
|
Holds a buffer that cannot be modified. |
|
Holds a registered buffer over non‐modifiable data. |
|
Provides support for implementing stackless coroutines. |
|
Encapsulates a deferred asynchronous operation. |
|
Encapsulates a deferred asynchronous operation thas has multiple completion signatures. |
|
Used to represent a deferred conditional branch. |
|
Wraps a function object so that it may be used as an element in a deferred composition. |
|
Tag type to disambiguate deferred constructors. |
|
Used to represent an empty deferred action. |
|
Defines a link between two consecutive operations in a sequence. |
|
Helper type to wrap multiple completion signatures. |
|
Class used to specify that an asynchronous operation should return a function object to lazily launch the operation. |
|
Encapsulates deferred values. |
|
A |
|
Specialisation of |
|
Specialisation of |
|
Specialisation of |
|
Adapt a basic_string to the DynamicBuffer requirements. |
|
Adapt a vector to the DynamicBuffer requirements. |
|
A context for function object execution. |
|
Polymorphic wrapper for executors. |
|
A special type, similar to std::nothrow_t, used to disambiguate constructors that accept executor arguments. |
|
A call wrapper type to bind an executor of type |
|
The file_base class is used as a base for the basic_stream_file and basic_random_access_file class templates so that we have a common place to define flags. |
|
A call wrapper type to bind a immediate executor of type |
|
Exception thrown when trying to add a service object to an execution_context where the service has a different owner. |
|
Provides core I/O functionality. |
|
|
|
Trait to determine whether a type satisfies the ConstBufferSequence requirements. |
|
The is_contiguous_iterator class is a traits class that may be used to determine whether a type is a contiguous iterator. |
|
Trait for detecting objects that are usable as deferred operations. |
|
|
|
|
|
Trait used for testing whether a type satisfies the requirements of a disposition. |
|
Trait to determine whether a type satisfies the DynamicBuffer requirements. |
|
Trait to determine whether a type satisfies the DynamicBuffer_v1 requirements. |
|
Trait to determine whether a type satisfies the DynamicBuffer_v2 requirements. |
|
The is_executor trait detects whether a type T meets the Executor type requirements. |
|
Type trait used to determine whether a type can be used as a match condition function with read_until and async_read_until. |
|
Trait to determine whether a type satisfies the MutableBufferSequence requirements. |
|
The is_read_buffered class is a traits class that may be used to determine whether a stream type supports buffering of read data. |
|
The is_write_buffered class is a traits class that may be used to determine whether a stream type supports buffering of written data. |
|
Exception thrown when there are multiple pending exceptions to rethrow. |
|
Holds a buffer that can be modified. |
|
Holds a registered buffer over modifiable data. |
|
A tag type used to indicate the absence of an error. |
|
(Deprecated: Use the socket/descriptor wait() and async_wait() member functions.) An implementation of both the ConstBufferSequence and MutableBufferSequence concepts to represent a null buffer sequence. |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
A function object type that adapts a |
|
Completion token type used to specify that the completion handler arguments should be passed additional values before the results of the operation. |
|
An allocator that caches memory blocks in thread‐local storage for reuse. |
|
A proto‐allocator that caches memory blocks in thread‐local storage for reuse. |
|
A |
|
Type used to identify a registered buffer. |
|
The serial_port_base class is used as a base for the basic_serial_port class template so that we have a common place to define the serial port options. |
|
Exception thrown when trying to add a duplicate service to an execution_context. |
|
The signal_set_base class is used as a base for the basic_signal_set class templates so that we have a common place to define the flags enum. |
|
The socket_base class is used as a base for the basic_stream_socket and basic_datagram_socket class templates so that we have a common place to define the shutdown_type and enum. |
|
Provides serialised function invocation for any executor type. |
|
The executor context for the system executor. |
|
A simple fixed‐size thread pool. |
|
A |
|
A |
|
The uses_executor trait detects whether a type T has an associated executor that is convertible from type Executor. |
|
|
|
Wait traits suitable for use with the basic_waitable_timer class template. |
|
A cancellation filter that disables cancellation. |
|
A cancellation filter that enables terminal cancellation only. |
|
Typedef for a timer based on the high resolution clock. |
|
Typedef for the typical usage of a random‐access file. |
|
Typedef for the typical usage of a readable pipe. |
|
Typedef for the typical usage of a serial port. |
|
Typedef for the typical usage of a signal set. |
|
Typedef for a timer based on the steady clock. |
|
Typedef for the typical usage of a stream‐oriented file. |
|
Typedef for the typical usage of basic_streambuf. |
|
An executor that uses arbitrary threads. |
|
Typedef for a timer based on the system clock. |
|
Typedef for the typical usage of a writable pipe. |
Functions
Name |
Description |
(Deprecated: Use make_service().) Add a service object to the execution_context. |
|
Completion token type used to specify that the completion handler arguments should be passed additional values after the results of the operation. |
|
Default continuation function for handlers. |
|
Launch an asynchronous operation with a stateful implementation. |
|
Asynchronously establishes a socket connection by trying each endpoint in a sequence. |
|
Launch a trivial asynchronous operation that completes immediately. |
|
Start an asynchronous operation to read a certain amount of data from a stream. |
|
Start an asynchronous operation to read a certain amount of data at the specified offset. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Get an iterator to the first element in a buffer sequence. |
|
Get an iterator to one past the end element in a buffer sequence. |
|
Get the total number of bytes in a buffer sequence. |
|
Construct an iterator representing the beginning of the buffers' data. |
|
Construct an iterator representing the end of the buffers' data. |
|
|
|
|
|
Creates an initiation function object that may be used to launch a coroutine‐based composed asynchronous operation. |
|
Spawn a new coroutined‐based thread of execution. |
|
Creates an initiation function object that may be used to launch an asynchronous operation with a stateful implementation. |
|
Establishes a socket connection by trying each endpoint in a sequence. |
|
Connect two pipe ends using an anonymous pipe. |
|
Completion token adapter used to specify that the completion handler should carry additional values along with it. |
|
Submits a completion token or function object for execution. |
|
Submits a completion token or function object for execution. |
|
|
|
Helper function to obtain an object's associated allocator. |
|
Helper function to obtain an object's associated cancellation_slot. |
|
Helper function to obtain an object's associated executor. |
|
Helper function to obtain an object's associated executor. |
|
Determine if an execution_context contains a specified service type. |
|
Creates a service object and adds it to the execution_context. |
|
|
|
Create an |
|
Bitwise and operator. |
|
Bitwise and‐assignment operator. |
|
Addition operators |
|
Subtraction operator. |
|
Bitwise xor operator. |
|
Bitwise xor‐assignment operator. |
|
Bitwise disjunction operators |
|
Bitwise or‐assignment operator. |
|
Bitwise negation operator. |
|
Submits a completion token or function object for execution. |
|
Completion token type used to specify that the completion handler arguments should be passed additional values before the results of the operation. |
|
Attempt to read a certain amount of data from a stream before returning. |
|
Attempt to read a certain amount of data at the specified offset before returning. |
|
|
|
|
|
Register buffers with an execution context. |
|
Helper function to throw an exception arising from a disposition. |
|
Helper function to convert a disposition to an |
|
Obtain the service object corresponding to the given type. |
|
|
|
|
|
Negation operator. |
|
Equality operators |
|
Inequality operators |
|
Compare two iterators. |
|
Compare two iterators. |
|
Compare two iterators. |
|
Compare two iterators. |
Variables
Name |
Description |
A function object that adapts a |
|
A |
|
A |
|
A special value, similar to std::nothrow, used to disambiguate constructors that accept executor arguments. |
|
A special value used to indicate the absence of an error. |
|
A |
boost::asio::buffer_literals namespace
boost::asio::chrono namespace
boost::asio::error namespace
boost::asio::execution namespace
Types
Name |
Description |
Exception thrown when trying to access an empty polymorphic executor. |
|
An archetypal function object used for determining adherence to the execution::executor concept. |
|
The is_executor trait detects whether a type T satisfies the execution::executor concept. |
|
boost::asio::generic namespace
Types
Name |
Description |
Describes an endpoint for any socket type. |
|
Encapsulates the flags needed for a generic datagram‐oriented socket. |
|
Encapsulates the flags needed for a generic raw socket. |
|
Encapsulates the flags needed for a generic sequenced packet socket. |
|
Encapsulates the flags needed for a generic stream‐oriented socket. |
boost::asio::ip namespace
Types
Name |
Description |
Implements version‐independent IP addresses. |
|
Implements IP version 4 style addresses. |
|
Implements IP version 6 style addresses. |
|
Thrown to indicate a failed address conversion. |
|
An input iterator that can be used for traversing IPv4 addresses. |
|
An input iterator that can be used for traversing IPv6 addresses. |
|
Represents a range of IPv4 addresses. |
|
Represents a range of IPv6 addresses. |
|
Describes an endpoint for a version‐independent IP socket. |
|
Provides endpoint resolution functionality. |
|
An entry produced by a resolver. |
|
An iterator over the entries produced by a resolver. |
|
An query to be passed to a resolver. |
|
A range of entries produced by a resolver. |
|
Encapsulates the flags needed for ICMP. |
|
Represents an IPv4 network. |
|
Represents an IPv6 network. |
|
The resolver_base class is used as a base for the basic_resolver class templates to provide a common place to define the flag constants. |
|
The resolver_query_base class is used as a base for the basic_resolver_query class templates to provide a common place to define the flag constants. |
|
Encapsulates the flags needed for TCP. |
|
Encapsulates the flags needed for UDP. |
|
An input iterator that can be used for traversing IPv4 addresses. |
|
Represents a range of IPv4 addresses. |
|
An input iterator that can be used for traversing IPv6 addresses. |
|
Represents a range of IPv6 addresses. |
|
Type used for storing port numbers. |
|
Type used for storing IPv6 scope IDs. |
|
Enums
Name |
Description |
Tag type used for distinguishing overloads that deal in IPv4‐mapped IPv6 addresses. |
Functions
Name |
Description |
Get the current host name. |
|
Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation. |
|
|
|
|
|
|
|
|
|
Stream insertion operators |
|
Equality operators |
|
Inequality operators |
|
Less‐than operators |
|
Less‐than‐or‐equal operators |
|
Greater‐than operators |
|
Greater‐than‐or‐equal operators |
boost::asio::ip::multicast namespace
boost::asio::ip::unicast namespace
boost::asio::local namespace
Types
Name |
Description |
Describes an endpoint for a UNIX socket. |
|
Encapsulates the flags needed for datagram‐oriented UNIX sockets. |
|
Encapsulates the flags needed for seq_packet UNIX sockets. |
|
Encapsulates the flags needed for stream‐oriented UNIX sockets. |
Functions
Name |
Description |
Create a pair of connected sockets. |
|
Output an endpoint as a string. |
|
Compare two endpoints for equality. |
|
Compare two endpoints for inequality. |
|
Compare endpoints for ordering. |
|
Compare endpoints for ordering. |
|
Compare endpoints for ordering. |
|
Compare endpoints for ordering. |
boost::asio::resolver_errc namespace
boost::asio::socket_errc namespace
boost::asio::stream_errc namespace
boost::asio::this_coro namespace
Types
Name |
Description |
Awaitable type that returns the cancellation state of the current coroutine. |
|
Awaitable type that returns the executor of the current coroutine. |
|
boost::asio::traits namespace
boost::asio::windows namespace
Types
Name |
Description |
Provides object‐oriented handle functionality. |
|
Provides Windows handle functionality for objects that support overlapped I/O. |
|
Provides random‐access handle functionality. |
|
Provides stream‐oriented handle functionality. |
|
Wraps a handler to create an OVERLAPPED object for use with overlapped I/O. |
|
Typedef for the typical usage of an object handle. |
|
Typedef for the typical usage of an overlapped handle. |
|
Typedef for the typical usage of a random‐access handle. |
|
Typedef for the typical usage of a stream‐oriented handle. |
Created with MrDocs