Edit: /usr/include/boost/asio/use_future.hpp (4820B)
//
// use_future.hpp
// ~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2020 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)
//
#ifndef BOOST_ASIO_USE_FUTURE_HPP
#define BOOST_ASIO_USE_FUTURE_HPP
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include
#include
#if defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS) \
|| defined(GENERATING_DOCUMENTATION)
#include
#include
#include
namespace boost {
namespace asio {
namespace detail {
template
class packaged_token;
template
class packaged_handler;
} // namespace detail
/// Class used to specify that an asynchronous operation should return a future.
/**
* The use_future_t class is used to indicate that an asynchronous operation
* should return a std::future object. A use_future_t object may be passed as a
* handler to an asynchronous operation, typically using the special value @c
* boost::asio::use_future. For example:
*
* @code std::future my_future
* = my_socket.async_read_some(my_buffer, boost::asio::use_future); @endcode
*
* The initiating function (async_read_some in the above example) returns a
* future that will receive the result of the operation. If the operation
* completes with an error_code indicating failure, it is converted into a
* system_error and passed back to the caller via the future.
*/
template >
class use_future_t
{
public:
/// The allocator type. The allocator is used when constructing the
/// @c std::promise object for a given asynchronous operation.
typedef Allocator allocator_type;
/// Construct using default-constructed allocator.
BOOST_ASIO_CONSTEXPR use_future_t()
{
}
/// Construct using specified allocator.
explicit use_future_t(const Allocator& allocator)
: allocator_(allocator)
{
}
#if !defined(BOOST_ASIO_NO_DEPRECATED)
/// (Deprecated: Use rebind().) Specify an alternate allocator.
template
use_future_t operator[](const OtherAllocator& allocator) const
{
return use_future_t(allocator);
}
#endif // !defined(BOOST_ASIO_NO_DEPRECATED)
/// Specify an alternate allocator.
template
use_future_t rebind(const OtherAllocator& allocator) const
{
return use_future_t(allocator);
}
/// Obtain allocator.
allocator_type get_allocator() const
{
return allocator_;
}
/// Wrap a function object in a packaged task.
/**
* The @c package function is used to adapt a function object as a packaged
* task. When this adapter is passed as a completion token to an asynchronous
* operation, the result of the function object is retuned via a std::future.
*
* @par Example
*
* @code std::future fut =
* my_socket.async_read_some(buffer,
* use_future([](boost::system::error_code ec, std::size_t n)
* {
* return ec ? 0 : n;
* }));
* ...
* std::size_t n = fut.get(); @endcode
*/
template
#if defined(GENERATING_DOCUMENTATION)
unspecified
#else // defined(GENERATING_DOCUMENTATION)
detail::packaged_token::type, Allocator>
#endif // defined(GENERATING_DOCUMENTATION)
operator()(BOOST_ASIO_MOVE_ARG(Function) f) const;
private:
// Helper type to ensure that use_future can be constexpr default-constructed
// even when std::allocator can't be.
struct std_allocator_void
{
BOOST_ASIO_CONSTEXPR std_allocator_void()
{
}
operator std::allocator() const
{
return std::allocator();
}
};
typename conditional<
is_same, Allocator>::value,
std_allocator_void, Allocator>::type allocator_;
};
/// A special value, similar to std::nothrow.
/**
* See the documentation for boost::asio::use_future_t for a usage example.
*/
#if defined(BOOST_ASIO_HAS_CONSTEXPR) || defined(GENERATING_DOCUMENTATION)
constexpr use_future_t<> use_future;
#elif defined(BOOST_ASIO_MSVC)
__declspec(selectany) use_future_t<> use_future;
#endif
} // namespace asio
} // namespace boost
#include
#include
#endif // defined(BOOST_ASIO_HAS_STD_FUTURE_CLASS)
// || defined(GENERATING_DOCUMENTATION)
#endif // BOOST_ASIO_USE_FUTURE_HPP