asio/test/cancel_after.cpp

//
// cancel_after.cpp
// ~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//

// Disable autolinking for unit tests.
#if !defined(BOOST_ALL_NO_LIB)
#define BOOST_ALL_NO_LIB 1
#endif // !defined(BOOST_ALL_NO_LIB)

// Test that header file is self-contained.
#include <boost/asio/cancel_after.hpp>

#include <functional>
#include <boost/asio/io_context.hpp>
#include <boost/asio/steady_timer.hpp>
#include "unit_test.hpp"

using namespace boost::asio;
namespace bindns = std;
namespace chronons = boost::asio::chrono;

void increment_on_cancel(int* count, const boost::system::error_code& error)
{
  if (error == boost::asio::error::operation_aborted)
    ++(*count);
}

void cancel_after_function_object_test()
{
  io_context ioc;
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(
      cancel_after(chronons::seconds(5),
        bindns::bind(&increment_on_cancel,
          &count, bindns::placeholders::_1)));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::milliseconds(100),
        bindns::bind(&increment_on_cancel,
          &count, bindns::placeholders::_1)));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::milliseconds(100));
  t.async_wait(
      cancel_after(chronons::seconds(5),
        cancel_after(chronons::seconds(10),
          bindns::bind(&increment_on_cancel,
            &count, bindns::placeholders::_1))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::milliseconds(100),
        cancel_after(chronons::seconds(10),
          bindns::bind(&increment_on_cancel,
            &count, bindns::placeholders::_1))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 2);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::seconds(10),
        cancel_after(chronons::milliseconds(100),
          bindns::bind(&increment_on_cancel,
            &count, bindns::placeholders::_1))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 3);
}

void cancel_after_timer_function_object_test()
{
  io_context ioc;
  steady_timer cancellation_timer1(ioc);
  steady_timer cancellation_timer2(ioc);
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(5),
        bindns::bind(&increment_on_cancel,
          &count, bindns::placeholders::_1)));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::milliseconds(100),
        bindns::bind(&increment_on_cancel,
          &count, bindns::placeholders::_1)));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::milliseconds(100));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(5),
        cancel_after(cancellation_timer2, chronons::seconds(10),
          bindns::bind(&increment_on_cancel,
            &count, bindns::placeholders::_1))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::milliseconds(100),
        cancel_after(cancellation_timer2, chronons::seconds(10),
          bindns::bind(&increment_on_cancel,
            &count, bindns::placeholders::_1))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 2);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(10),
        cancel_after(cancellation_timer2, chronons::milliseconds(100),
          bindns::bind(&increment_on_cancel,
            &count, bindns::placeholders::_1))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 3);
}

struct incrementer_token_v1
{
  explicit incrementer_token_v1(int* c) : count(c) {}
  int* count;
};

struct incrementer_handler_v1
{
  explicit incrementer_handler_v1(incrementer_token_v1 t) : count(t.count) {}

  void operator()(boost::system::error_code error)
  {
    increment_on_cancel(count, error);
  }

  int* count;
};

namespace boost {
namespace asio {

template <>
class async_result<incrementer_token_v1, void(boost::system::error_code)>
{
public:
  typedef incrementer_handler_v1 completion_handler_type;
  typedef void return_type;
  explicit async_result(completion_handler_type&) {}
  return_type get() {}
};

} // namespace asio
} // namespace boost

void cancel_after_completion_token_v1_test()
{
  io_context ioc;
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(
      cancel_after(chronons::seconds(5),
        incrementer_token_v1(&count)));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::milliseconds(100),
        bindns::bind(&increment_on_cancel,
          &count, bindns::placeholders::_1)));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::milliseconds(100));
  t.async_wait(
      cancel_after(chronons::seconds(5),
        cancel_after(chronons::seconds(10),
          incrementer_token_v1(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::milliseconds(100),
        cancel_after(chronons::seconds(10),
          incrementer_token_v1(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 2);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::seconds(10),
        cancel_after(chronons::milliseconds(100),
          incrementer_token_v1(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 3);
}

void cancel_after_timer_completion_token_v1_test()
{
  io_context ioc;
  steady_timer cancellation_timer1(ioc);
  steady_timer cancellation_timer2(ioc);
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(5),
        incrementer_token_v1(&count)));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::milliseconds(100),
        bindns::bind(&increment_on_cancel,
          &count, bindns::placeholders::_1)));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::milliseconds(100));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(5),
        cancel_after(cancellation_timer2, chronons::seconds(10),
          incrementer_token_v1(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::milliseconds(100),
        cancel_after(cancellation_timer2, chronons::seconds(10),
          incrementer_token_v1(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 2);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(10),
        cancel_after(cancellation_timer2, chronons::milliseconds(100),
          incrementer_token_v1(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 3);
}

struct incrementer_token_v2
{
  explicit incrementer_token_v2(int* c) : count(c) {}
  int* count;
};

namespace boost {
namespace asio {

template <>
class async_result<incrementer_token_v2, void(boost::system::error_code)>
{
public:
  template <typename Initiation, typename... Args>
  static void initiate(Initiation initiation,
      incrementer_token_v2 token, Args&&... args)
  {
    initiation(
        bindns::bind(&increment_on_cancel,
          token.count, bindns::placeholders::_1),
        static_cast<Args&&>(args)...);
  }
};

} // namespace asio
} // namespace boost

void cancel_after_completion_token_v2_test()
{
  io_context ioc;
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(
      cancel_after(chronons::seconds(5),
        incrementer_token_v2(&count)));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::milliseconds(100),
        incrementer_token_v2(&count)));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::milliseconds(100));
  t.async_wait(
      cancel_after(chronons::seconds(5),
        cancel_after(chronons::seconds(10),
          incrementer_token_v2(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::milliseconds(100),
        cancel_after(chronons::seconds(10),
          incrementer_token_v2(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 2);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(chronons::seconds(10),
        cancel_after(chronons::milliseconds(100),
          incrementer_token_v2(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 3);
}

void cancel_after_timer_completion_token_v2_test()
{
  io_context ioc;
  steady_timer cancellation_timer1(ioc);
  steady_timer cancellation_timer2(ioc);
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(5),
        incrementer_token_v2(&count)));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::milliseconds(100),
        incrementer_token_v2(&count)));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::milliseconds(100));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(5),
        cancel_after(cancellation_timer2, chronons::seconds(10),
          incrementer_token_v2(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::milliseconds(100),
        cancel_after(cancellation_timer2, chronons::seconds(10),
          incrementer_token_v2(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 2);

  t.expires_after(chronons::seconds(5));
  t.async_wait(
      cancel_after(cancellation_timer1, chronons::seconds(10),
        cancel_after(cancellation_timer2, chronons::milliseconds(100),
          incrementer_token_v2(&count))));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 3);
}

void partial_cancel_after_test()
{
  io_context ioc;
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(cancel_after(chronons::seconds(5)))(
      incrementer_token_v2(&count));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(cancel_after(chronons::milliseconds(100)))(
      incrementer_token_v2(&count));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);
}

void partial_cancel_after_timer_test()
{
  io_context ioc;
  steady_timer cancellation_timer(ioc);
  int count = 0;

  steady_timer t(ioc, chronons::milliseconds(100));
  t.async_wait(cancel_after(cancellation_timer, chronons::seconds(5)))(
      incrementer_token_v2(&count));

  ioc.run();

  BOOST_ASIO_CHECK(count == 0);

  t.expires_after(chronons::seconds(5));
  t.async_wait(cancel_after(cancellation_timer, chronons::milliseconds(100)))(
      incrementer_token_v2(&count));

  ioc.restart();
  ioc.run();

  BOOST_ASIO_CHECK(count == 1);
}

BOOST_ASIO_TEST_SUITE
(
  "cancel_after",
  BOOST_ASIO_TEST_CASE(cancel_after_function_object_test)
  BOOST_ASIO_TEST_CASE(cancel_after_timer_function_object_test)
  BOOST_ASIO_TEST_CASE(cancel_after_completion_token_v1_test)
  BOOST_ASIO_TEST_CASE(cancel_after_timer_completion_token_v1_test)
  BOOST_ASIO_TEST_CASE(cancel_after_completion_token_v2_test)
  BOOST_ASIO_TEST_CASE(cancel_after_timer_completion_token_v2_test)
  BOOST_ASIO_TEST_CASE(partial_cancel_after_test)
  BOOST_ASIO_TEST_CASE(partial_cancel_after_timer_test)
)