asio/detail/win_iocp_socket_recvmsg_op.hpp

0001 //
0002 // detail/win_iocp_socket_recvmsg_op.hpp
0003 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0004 //
0005 // Copyright (c) 2003-2023 Christopher M. Kohlhoff (chris at kohlhoff dot com)
0006 //
0007 // Distributed under the Boost Software License, Version 1.0. (See accompanying
0008 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0009 //
0010
0011 #ifndef BOOST_ASIO_DETAIL_WIN_IOCP_SOCKET_RECVMSG_OP_HPP
0012 #define BOOST_ASIO_DETAIL_WIN_IOCP_SOCKET_RECVMSG_OP_HPP
0013
0014 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
0015 # pragma once
0016 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
0017
0018 #include <boost/asio/detail/config.hpp>
0019
0020 #if defined(BOOST_ASIO_HAS_IOCP)
0021
0022 #include <boost/asio/detail/bind_handler.hpp>
0023 #include <boost/asio/detail/buffer_sequence_adapter.hpp>
0024 #include <boost/asio/detail/fenced_block.hpp>
0025 #include <boost/asio/detail/handler_alloc_helpers.hpp>
0026 #include <boost/asio/detail/handler_work.hpp>
0027 #include <boost/asio/detail/memory.hpp>
0028 #include <boost/asio/detail/operation.hpp>
0029 #include <boost/asio/detail/socket_ops.hpp>
0030 #include <boost/asio/error.hpp>
0031 #include <boost/asio/socket_base.hpp>
0032
0033 #include <boost/asio/detail/push_options.hpp>
0034
0035 namespace boost {
0036 namespace asio {
0037 namespace detail {
0038
0039 template <typename MutableBufferSequence, typename Handler, typename IoExecutor>
0040 class win_iocp_socket_recvmsg_op : public operation
0041 {
0042 public:
0043   BOOST_ASIO_DEFINE_HANDLER_PTR(win_iocp_socket_recvmsg_op);
0044
0045   win_iocp_socket_recvmsg_op(
0046       socket_ops::weak_cancel_token_type cancel_token,
0047       const MutableBufferSequence& buffers,
0048       socket_base::message_flags& out_flags,
0049       Handler& handler, const IoExecutor& io_ex)
0050     : operation(&win_iocp_socket_recvmsg_op::do_complete),
0051       cancel_token_(cancel_token),
0052       buffers_(buffers),
0053       out_flags_(out_flags),
0054       handler_(static_cast<Handler&&>(handler)),
0055       work_(handler_, io_ex)
0056   {
0057   }
0058
0059   static void do_complete(void* owner, operation* base,
0060       const boost::system::error_code& result_ec,
0061       std::size_t bytes_transferred)
0062   {
0063     boost::system::error_code ec(result_ec);
0064
0065     // Take ownership of the operation object.
0066     BOOST_ASIO_ASSUME(base != 0);
0067     win_iocp_socket_recvmsg_op* o(
0068         static_cast<win_iocp_socket_recvmsg_op*>(base));
0069     ptr p = { boost::asio::detail::addressof(o->handler_), o, o };
0070
0071     BOOST_ASIO_HANDLER_COMPLETION((*o));
0072
0073     // Take ownership of the operation's outstanding work.
0074     handler_work<Handler, IoExecutor> w(
0075         static_cast<handler_work<Handler, IoExecutor>&&>(
0076           o->work_));
0077
0078 #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
0079     // Check whether buffers are still valid.
0080     if (owner)
0081     {
0082       buffer_sequence_adapter<boost::asio::mutable_buffer,
0083           MutableBufferSequence>::validate(o->buffers_);
0084     }
0085 #endif // defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
0086
0087     socket_ops::complete_iocp_recvmsg(o->cancel_token_, ec);
0088     o->out_flags_ = 0;
0089
0090     BOOST_ASIO_ERROR_LOCATION(ec);
0091
0092     // Make a copy of the handler so that the memory can be deallocated before
0093     // the upcall is made. Even if we're not about to make an upcall, a
0094     // sub-object of the handler may be the true owner of the memory associated
0095     // with the handler. Consequently, a local copy of the handler is required
0096     // to ensure that any owning sub-object remains valid until after we have
0097     // deallocated the memory here.
0098     detail::binder2<Handler, boost::system::error_code, std::size_t>
0099       handler(o->handler_, ec, bytes_transferred);
0100     p.h = boost::asio::detail::addressof(handler.handler_);
0101     p.reset();
0102
0103     // Make the upcall if required.
0104     if (owner)
0105     {
0106       fenced_block b(fenced_block::half);
0107       BOOST_ASIO_HANDLER_INVOCATION_BEGIN((handler.arg1_, handler.arg2_));
0108       w.complete(handler, handler.handler_);
0109       BOOST_ASIO_HANDLER_INVOCATION_END;
0110     }
0111   }
0112
0113 private:
0114   socket_ops::weak_cancel_token_type cancel_token_;
0115   MutableBufferSequence buffers_;
0116   socket_base::message_flags& out_flags_;
0117   Handler handler_;
0118   handler_work<Handler, IoExecutor> work_;
0119 };
0120
0121 } // namespace detail
0122 } // namespace asio
0123 } // namespace boost
0124
0125 #include <boost/asio/detail/pop_options.hpp>
0126
0127 #endif // defined(BOOST_ASIO_HAS_IOCP)
0128
0129 #endif // BOOST_ASIO_DETAIL_WIN_IOCP_SOCKET_RECVMSG_OP_HPP