Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This version of Boost is under active development. You are currently in the master branch. The current version is 1.89.0.

basic_signal_set::cancel (1 of 2 overloads)

basic_signal_set::cancel (1 of 2 overloads)

Cancel all operations associated with the signal set.

void cancel();

This function forces the completion of any pending asynchronous wait operations against the signal set. The handler for each cancelled operation will be invoked with the boost::asio::error::operation_aborted error code.

Cancellation does not alter the set of registered signals.

Exceptions

boost::system::system_error: Thrown on failure.

Remarks

If a registered signal occurred before cancel() is called, then the handlers for asynchronous wait operations will:

have already been invoked; or
have been queued for invocation in the near future.

These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.