| Home | Libraries | People | FAQ | More

##### basic_waitable_timer::cancel_one (2 of 2 overloads)

(Deprecated: Use non-error_code overload.) Cancels one asynchronous operation that is waiting on the timer.

    std::size_t cancel_one(
        boost::system::error_code & ec);

This function forces the completion of one pending asynchronous wait operation against the timer. Handlers are cancelled in FIFO order. The handler for the cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.

Cancelling the timer does not change the expiry time.

###### Parameters

ec

  Set to indicate what error occurred, if any.

###### Return Value

The number of asynchronous operations that were cancelled. That is, either 0 or 1.

###### Remarks

If the timer has already expired when `cancel_one()` 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.