2 // windows/overlapped_ptr.hpp
3 // ~~~~~~~~~~~~~~~~~~~~~~~~~~
5 // Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com)
7 // Distributed under the Boost Software License, Version 1.0. (See accompanying
8 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
11 #ifndef BOOST_ASIO_WINDOWS_OVERLAPPED_PTR_HPP
12 #define BOOST_ASIO_WINDOWS_OVERLAPPED_PTR_HPP
14 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
16 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
18 #include <boost/asio/detail/config.hpp>
20 #if defined(BOOST_ASIO_HAS_WINDOWS_OVERLAPPED_PTR) \
21 || defined(GENERATING_DOCUMENTATION)
23 #include <boost/asio/detail/noncopyable.hpp>
24 #include <boost/asio/detail/win_iocp_overlapped_ptr.hpp>
25 #include <boost/asio/io_service.hpp>
27 #include <boost/asio/detail/push_options.hpp>
33 /// Wraps a handler to create an OVERLAPPED object for use with overlapped I/O.
35 * A special-purpose smart pointer used to wrap an application handler so that
36 * it can be passed as the LPOVERLAPPED argument to overlapped I/O functions.
39 * @e Distinct @e objects: Safe.@n
40 * @e Shared @e objects: Unsafe.
46 /// Construct an empty overlapped_ptr.
52 /// Construct an overlapped_ptr to contain the specified handler.
53 template <typename Handler>
54 explicit overlapped_ptr(boost::asio::io_service& io_service,
55 BOOST_ASIO_MOVE_ARG(Handler) handler)
56 : impl_(io_service, BOOST_ASIO_MOVE_CAST(Handler)(handler))
60 /// Destructor automatically frees the OVERLAPPED object unless released.
71 /// Reset to contain the specified handler, freeing any current OVERLAPPED
73 template <typename Handler>
74 void reset(boost::asio::io_service& io_service,
75 BOOST_ASIO_MOVE_ARG(Handler) handler)
77 impl_.reset(io_service, BOOST_ASIO_MOVE_CAST(Handler)(handler));
80 /// Get the contained OVERLAPPED object.
86 /// Get the contained OVERLAPPED object.
87 const OVERLAPPED* get() const
92 /// Release ownership of the OVERLAPPED object.
95 return impl_.release();
98 /// Post completion notification for overlapped operation. Releases ownership.
99 void complete(const boost::system::error_code& ec,
100 std::size_t bytes_transferred)
102 impl_.complete(ec, bytes_transferred);
106 detail::win_iocp_overlapped_ptr impl_;
109 } // namespace windows
113 #include <boost/asio/detail/pop_options.hpp>
115 #endif // defined(BOOST_ASIO_HAS_WINDOWS_OVERLAPPED_PTR)
116 // || defined(GENERATING_DOCUMENTATION)
118 #endif // BOOST_ASIO_WINDOWS_OVERLAPPED_PTR_HPP