asio/test/as_tuple.cpp

//
// as_tuple.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/as_tuple.hpp>

#include <boost/asio/bind_executor.hpp>
#include <boost/asio/deferred.hpp>
#include <boost/asio/io_context.hpp>
#include <boost/asio/post.hpp>
#include <boost/asio/system_timer.hpp>
#include <boost/asio/use_future.hpp>
#include "unit_test.hpp"

void as_tuple_test()
{
  boost::asio::io_context io1;
  boost::asio::io_context io2;
  boost::asio::system_timer timer1(io1);
  int count = 0;

  timer1.expires_after(boost::asio::chrono::seconds(0));
  timer1.async_wait(
      boost::asio::as_tuple(
        boost::asio::bind_executor(io2.get_executor(),
          [&count](std::tuple<boost::system::error_code>)
          {
            ++count;
          })));

  BOOST_ASIO_CHECK(count == 0);

  io1.run();

  BOOST_ASIO_CHECK(count == 0);

  io2.run();

  BOOST_ASIO_CHECK(count == 1);

  timer1.async_wait(
      boost::asio::as_tuple(
        boost::asio::bind_executor(io2.get_executor(),
          boost::asio::deferred)))(
            [&count](std::tuple<boost::system::error_code>)
            {
              ++count;
            });

  BOOST_ASIO_CHECK(count == 1);

  io1.restart();
  io1.run();

  BOOST_ASIO_CHECK(count == 1);

  io2.restart();
  io2.run();

  BOOST_ASIO_CHECK(count == 2);

# if defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS)
  std::future<std::tuple<boost::system::error_code> > f = timer1.async_wait(
      boost::asio::as_tuple(
        boost::asio::bind_executor(io2.get_executor(),
          boost::asio::use_future)));

  BOOST_ASIO_CHECK(f.wait_for(std::chrono::seconds(0))
      == std::future_status::timeout);

  io1.restart();
  io1.run();

  BOOST_ASIO_CHECK(f.wait_for(std::chrono::seconds(0))
      == std::future_status::timeout);

  io2.restart();
  io2.run();

  BOOST_ASIO_CHECK(f.wait_for(std::chrono::seconds(0))
      == std::future_status::ready);
# endif // defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS)
}

void as_tuple_constness_test()
{
# if defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS)
  boost::asio::io_context io1;
  boost::asio::system_timer timer1(io1);

  auto tok1 = boost::asio::as_tuple(boost::asio::use_future);
  (void)timer1.async_wait(tok1);
  (void)timer1.async_wait(std::move(tok1));

  const auto tok2 = boost::asio::as_tuple(boost::asio::use_future);
  (void)timer1.async_wait(tok2);
  (void)timer1.async_wait(std::move(tok2));

  constexpr auto tok3 = boost::asio::as_tuple(boost::asio::use_future);
  (void)timer1.async_wait(tok3);
  (void)timer1.async_wait(std::move(tok3));
# endif // defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS)
}

void partial_as_tuple_test()
{
  boost::asio::io_context io1;
  boost::asio::io_context io2;
  boost::asio::system_timer timer1(io1);
  int count = 0;

  timer1.expires_after(boost::asio::chrono::seconds(0));
  timer1.async_wait(boost::asio::as_tuple)(
      boost::asio::bind_executor(io2.get_executor(),
        [&count](std::tuple<boost::system::error_code>)
        {
          ++count;
        }));

  BOOST_ASIO_CHECK(count == 0);

  io1.run();

  BOOST_ASIO_CHECK(count == 0);

  io2.run();

  BOOST_ASIO_CHECK(count == 1);

  timer1.async_wait(boost::asio::as_tuple)(
      boost::asio::bind_executor(io2.get_executor(),
        boost::asio::deferred))(
          [&count](std::tuple<boost::system::error_code>)
          {
            ++count;
          });

  BOOST_ASIO_CHECK(count == 1);

  io1.restart();
  io1.run();

  BOOST_ASIO_CHECK(count == 1);

  io2.restart();
  io2.run();

  BOOST_ASIO_CHECK(count == 2);

# if defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS)
  std::future<std::tuple<boost::system::error_code> > f
    = timer1.async_wait(boost::asio::as_tuple)(
        boost::asio::bind_executor(io2.get_executor(),
          boost::asio::use_future));

  BOOST_ASIO_CHECK(f.wait_for(std::chrono::seconds(0))
      == std::future_status::timeout);

  io1.restart();
  io1.run();

  BOOST_ASIO_CHECK(f.wait_for(std::chrono::seconds(0))
      == std::future_status::timeout);

  io2.restart();
  io2.run();

  BOOST_ASIO_CHECK(f.wait_for(std::chrono::seconds(0))
      == std::future_status::ready);
# endif // defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS)
}

BOOST_ASIO_TEST_SUITE
(
  "as_tuple",
  BOOST_ASIO_TEST_CASE(as_tuple_test)
  BOOST_ASIO_COMPILE_TEST_CASE(as_tuple_constness_test)
  BOOST_ASIO_TEST_CASE(partial_as_tuple_test)
)