boost::corosio::io_context

An I/O context for running asynchronous operations.

Synopsis

class io_context
    : public capy::execution_context

Description

The io_context provides an execution environment for async operations. It maintains a queue of pending work items and processes them when run() is called.

The default and unsigned constructors select the platform's native backend:

  • Windows: IOCP

  • Linux: epoll

  • BSD/macOS: kqueue

  • Other POSIX: select

The template constructor accepts a backend tag value to choose a specific backend at compile time:

Example

io_context ioc;                   // platform default
io_context ioc2(corosio::epoll);  // explicit backend

Thread Safety

Distinct objects: Safe. Shared objects: Safe, if using a concurrency hint greater than 1.

Base Classes

Name

Description

capy::execution_context

Types

Name

Description

executor_type

The executor type for this context.

service

Abstract base class for services owned by an execution context.

Member Functions

Name

Description

io_context [constructor]

Constructors

~io_context [destructor]

Destructor

operator= [deleted]

Assignment operators

find_service

Return a pointer to the service of type T, or nullptr.

get_executor

Return an executor for this context.

get_frame_allocator

Return the memory resource used for coroutine frame allocation.

has_service

Return true if a service of type T exists.

make_service

Construct and add a service.

poll

Process all ready work items without blocking.

poll_one

Process at most one ready work item without blocking.

restart

Restart the context after being stopped.

run

Process all pending work items.

run_for

Process work items for the specified duration.

run_one

Process at most one pending work item.

run_one_for

Process at most one work item for the specified duration.

run_one_until

Process at most one work item until the specified time.

run_until

Process work items until the specified time.

set_frame_allocator

set_frame_allocator overloads

stop

Signal the context to stop processing.

stopped

Return whether the context has been stopped.

target

Return a pointer to this context if it matches the requested type.

use_service

Return a reference to the service of type T, creating it if needed.

Protected Member Functions

Name

Description

destroy

Destroy all services.

shutdown

Shut down all services.

Protected Data Members

Name

sched_

Derived Classes

Name

Description

native_io_context

An I/O context with devirtualized event loop methods.

See Also

epoll_t, select_t, kqueue_t, iocp_t

Created with MrDocs