Initial Commit
This commit is contained in:
485
include/asio/windows/basic_object_handle.hpp
Normal file
485
include/asio/windows/basic_object_handle.hpp
Normal file
@@ -0,0 +1,485 @@
|
||||
//
|
||||
// windows/basic_object_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
|
||||
// Copyright (c) 2011 Boris Schaeling (boris@highscore.de)
|
||||
//
|
||||
// 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 ASIO_WINDOWS_BASIC_OBJECT_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_BASIC_OBJECT_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include <utility>
|
||||
#include "asio/any_io_executor.hpp"
|
||||
#include "asio/async_result.hpp"
|
||||
#include "asio/detail/io_object_impl.hpp"
|
||||
#include "asio/detail/throw_error.hpp"
|
||||
#include "asio/detail/win_object_handle_service.hpp"
|
||||
#include "asio/error.hpp"
|
||||
#include "asio/execution_context.hpp"
|
||||
|
||||
#include "asio/detail/push_options.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Provides object-oriented handle functionality.
|
||||
/**
|
||||
* The windows::basic_object_handle class provides asynchronous and blocking
|
||||
* object-oriented handle functionality.
|
||||
*
|
||||
* @par Thread Safety
|
||||
* @e Distinct @e objects: Safe.@n
|
||||
* @e Shared @e objects: Unsafe.
|
||||
*/
|
||||
template <typename Executor = any_io_executor>
|
||||
class basic_object_handle
|
||||
{
|
||||
private:
|
||||
class initiate_async_wait;
|
||||
|
||||
public:
|
||||
/// The type of the executor associated with the object.
|
||||
typedef Executor executor_type;
|
||||
|
||||
/// Rebinds the handle type to another executor.
|
||||
template <typename Executor1>
|
||||
struct rebind_executor
|
||||
{
|
||||
/// The handle type when rebound to the specified executor.
|
||||
typedef basic_object_handle<Executor1> other;
|
||||
};
|
||||
|
||||
/// The native representation of a handle.
|
||||
#if defined(GENERATING_DOCUMENTATION)
|
||||
typedef implementation_defined native_handle_type;
|
||||
#else
|
||||
typedef asio::detail::win_object_handle_service::native_handle_type
|
||||
native_handle_type;
|
||||
#endif
|
||||
|
||||
/// An object handle is always the lowest layer.
|
||||
typedef basic_object_handle lowest_layer_type;
|
||||
|
||||
/// Construct an object handle without opening it.
|
||||
/**
|
||||
* This constructor creates an object handle without opening it.
|
||||
*
|
||||
* @param ex The I/O executor that the object handle will use, by default, to
|
||||
* dispatch handlers for any asynchronous operations performed on the
|
||||
* object handle.
|
||||
*/
|
||||
explicit basic_object_handle(const executor_type& ex)
|
||||
: impl_(0, ex)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct an object handle without opening it.
|
||||
/**
|
||||
* This constructor creates an object handle without opening it.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the object handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the object handle.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
explicit basic_object_handle(ExecutionContext& context,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: impl_(0, 0, context)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct an object handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates an object handle object to hold an existing native
|
||||
* handle.
|
||||
*
|
||||
* @param ex The I/O executor that the object handle will use, by default, to
|
||||
* dispatch handlers for any asynchronous operations performed on the
|
||||
* object handle.
|
||||
*
|
||||
* @param native_handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
basic_object_handle(const executor_type& ex,
|
||||
const native_handle_type& native_handle)
|
||||
: impl_(0, ex)
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().assign(impl_.get_implementation(), native_handle, ec);
|
||||
asio::detail::throw_error(ec, "assign");
|
||||
}
|
||||
|
||||
/// Construct an object handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates an object handle object to hold an existing native
|
||||
* handle.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the object handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the object handle.
|
||||
*
|
||||
* @param native_handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
basic_object_handle(ExecutionContext& context,
|
||||
const native_handle_type& native_handle,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value
|
||||
> = 0)
|
||||
: impl_(0, 0, context)
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().assign(impl_.get_implementation(), native_handle, ec);
|
||||
asio::detail::throw_error(ec, "assign");
|
||||
}
|
||||
|
||||
/// Move-construct an object handle from another.
|
||||
/**
|
||||
* This constructor moves an object handle from one object to another.
|
||||
*
|
||||
* @param other The other object handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_object_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_object_handle(basic_object_handle&& other)
|
||||
: impl_(std::move(other.impl_))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign an object handle from another.
|
||||
/**
|
||||
* This assignment operator moves an object handle from one object to another.
|
||||
*
|
||||
* @param other The other object handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_object_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_object_handle& operator=(basic_object_handle&& other)
|
||||
{
|
||||
impl_ = std::move(other.impl_);
|
||||
return *this;
|
||||
}
|
||||
|
||||
// All handles have access to each other's implementations.
|
||||
template <typename Executor1>
|
||||
friend class basic_object_handle;
|
||||
|
||||
/// Move-construct an object handle from a handle of another executor type.
|
||||
/**
|
||||
* This constructor moves an object handle from one object to another.
|
||||
*
|
||||
* @param other The other object handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_object_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
basic_object_handle(basic_object_handle<Executor1>&& other,
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: impl_(std::move(other.impl_))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign an object handle from a handle of another executor type.
|
||||
/**
|
||||
* This assignment operator moves an object handle from one object to another.
|
||||
*
|
||||
* @param other The other object handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_object_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
basic_object_handle&
|
||||
> operator=(basic_object_handle<Executor1>&& other)
|
||||
{
|
||||
impl_ = std::move(other.impl_);
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Get the executor associated with the object.
|
||||
const executor_type& get_executor() noexcept
|
||||
{
|
||||
return impl_.get_executor();
|
||||
}
|
||||
|
||||
/// Get a reference to the lowest layer.
|
||||
/**
|
||||
* This function returns a reference to the lowest layer in a stack of
|
||||
* layers. Since an object handle cannot contain any further layers, it simply
|
||||
* returns a reference to itself.
|
||||
*
|
||||
* @return A reference to the lowest layer in the stack of layers. Ownership
|
||||
* is not transferred to the caller.
|
||||
*/
|
||||
lowest_layer_type& lowest_layer()
|
||||
{
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Get a const reference to the lowest layer.
|
||||
/**
|
||||
* This function returns a const reference to the lowest layer in a stack of
|
||||
* layers. Since an object handle cannot contain any further layers, it simply
|
||||
* returns a reference to itself.
|
||||
*
|
||||
* @return A const reference to the lowest layer in the stack of layers.
|
||||
* Ownership is not transferred to the caller.
|
||||
*/
|
||||
const lowest_layer_type& lowest_layer() const
|
||||
{
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Assign an existing native handle to the handle.
|
||||
/*
|
||||
* This function opens the handle to hold an existing native handle.
|
||||
*
|
||||
* @param handle A native handle.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
void assign(const native_handle_type& handle)
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().assign(impl_.get_implementation(), handle, ec);
|
||||
asio::detail::throw_error(ec, "assign");
|
||||
}
|
||||
|
||||
/// Assign an existing native handle to the handle.
|
||||
/*
|
||||
* This function opens the handle to hold an existing native handle.
|
||||
*
|
||||
* @param handle A native handle.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
ASIO_SYNC_OP_VOID assign(const native_handle_type& handle,
|
||||
asio::error_code& ec)
|
||||
{
|
||||
impl_.get_service().assign(impl_.get_implementation(), handle, ec);
|
||||
ASIO_SYNC_OP_VOID_RETURN(ec);
|
||||
}
|
||||
|
||||
/// Determine whether the handle is open.
|
||||
bool is_open() const
|
||||
{
|
||||
return impl_.get_service().is_open(impl_.get_implementation());
|
||||
}
|
||||
|
||||
/// Close the handle.
|
||||
/**
|
||||
* This function is used to close the handle. Any asynchronous read or write
|
||||
* operations will be cancelled immediately, and will complete with the
|
||||
* asio::error::operation_aborted error.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
void close()
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().close(impl_.get_implementation(), ec);
|
||||
asio::detail::throw_error(ec, "close");
|
||||
}
|
||||
|
||||
/// Close the handle.
|
||||
/**
|
||||
* This function is used to close the handle. Any asynchronous read or write
|
||||
* operations will be cancelled immediately, and will complete with the
|
||||
* asio::error::operation_aborted error.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
ASIO_SYNC_OP_VOID close(asio::error_code& ec)
|
||||
{
|
||||
impl_.get_service().close(impl_.get_implementation(), ec);
|
||||
ASIO_SYNC_OP_VOID_RETURN(ec);
|
||||
}
|
||||
|
||||
/// Get the native handle representation.
|
||||
/**
|
||||
* This function may be used to obtain the underlying representation of the
|
||||
* handle. This is intended to allow access to native handle functionality
|
||||
* that is not otherwise provided.
|
||||
*/
|
||||
native_handle_type native_handle()
|
||||
{
|
||||
return impl_.get_service().native_handle(impl_.get_implementation());
|
||||
}
|
||||
|
||||
/// Cancel all asynchronous operations associated with the handle.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous read or write operations
|
||||
* to finish immediately, and the handlers for cancelled operations will be
|
||||
* passed the asio::error::operation_aborted error.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
void cancel()
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().cancel(impl_.get_implementation(), ec);
|
||||
asio::detail::throw_error(ec, "cancel");
|
||||
}
|
||||
|
||||
/// Cancel all asynchronous operations associated with the handle.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous read or write operations
|
||||
* to finish immediately, and the handlers for cancelled operations will be
|
||||
* passed the asio::error::operation_aborted error.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
ASIO_SYNC_OP_VOID cancel(asio::error_code& ec)
|
||||
{
|
||||
impl_.get_service().cancel(impl_.get_implementation(), ec);
|
||||
ASIO_SYNC_OP_VOID_RETURN(ec);
|
||||
}
|
||||
|
||||
/// Perform a blocking wait on the object handle.
|
||||
/**
|
||||
* This function is used to wait for the object handle to be set to the
|
||||
* signalled state. This function blocks and does not return until the object
|
||||
* handle has been set to the signalled state.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
void wait()
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().wait(impl_.get_implementation(), ec);
|
||||
asio::detail::throw_error(ec, "wait");
|
||||
}
|
||||
|
||||
/// Perform a blocking wait on the object handle.
|
||||
/**
|
||||
* This function is used to wait for the object handle to be set to the
|
||||
* signalled state. This function blocks and does not return until the object
|
||||
* handle has been set to the signalled state.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
void wait(asio::error_code& ec)
|
||||
{
|
||||
impl_.get_service().wait(impl_.get_implementation(), ec);
|
||||
}
|
||||
|
||||
/// Start an asynchronous wait on the object handle.
|
||||
/**
|
||||
* This function is be used to initiate an asynchronous wait against the
|
||||
* object handle. It is an initiating function for an @ref
|
||||
* asynchronous_operation, and always returns immediately.
|
||||
*
|
||||
* @param token The @ref completion_token that will be used to produce a
|
||||
* completion handler, which will be called when the wait completes.
|
||||
* Potential completion tokens include @ref use_future, @ref use_awaitable,
|
||||
* @ref yield_context, or a function object with the correct completion
|
||||
* signature. The function signature of the completion handler must be:
|
||||
* @code void handler(
|
||||
* const asio::error_code& error // Result of operation.
|
||||
* ); @endcode
|
||||
* Regardless of whether the asynchronous operation completes immediately or
|
||||
* not, the completion handler will not be invoked from within this function.
|
||||
* On immediate completion, invocation of the handler will be performed in a
|
||||
* manner equivalent to using asio::async_immediate().
|
||||
*
|
||||
* @par Completion Signature
|
||||
* @code void(asio::error_code) @endcode
|
||||
*/
|
||||
template <
|
||||
ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code))
|
||||
WaitToken = default_completion_token_t<executor_type>>
|
||||
auto async_wait(
|
||||
WaitToken&& token = default_completion_token_t<executor_type>())
|
||||
-> decltype(
|
||||
async_initiate<WaitToken, void (asio::error_code)>(
|
||||
declval<initiate_async_wait>(), token))
|
||||
{
|
||||
return async_initiate<WaitToken, void (asio::error_code)>(
|
||||
initiate_async_wait(this), token);
|
||||
}
|
||||
|
||||
private:
|
||||
// Disallow copying and assignment.
|
||||
basic_object_handle(const basic_object_handle&) = delete;
|
||||
basic_object_handle& operator=(const basic_object_handle&) = delete;
|
||||
|
||||
class initiate_async_wait
|
||||
{
|
||||
public:
|
||||
typedef Executor executor_type;
|
||||
|
||||
explicit initiate_async_wait(basic_object_handle* self)
|
||||
: self_(self)
|
||||
{
|
||||
}
|
||||
|
||||
const executor_type& get_executor() const noexcept
|
||||
{
|
||||
return self_->get_executor();
|
||||
}
|
||||
|
||||
template <typename WaitHandler>
|
||||
void operator()(WaitHandler&& handler) const
|
||||
{
|
||||
// If you get an error on the following line it means that your handler
|
||||
// does not meet the documented type requirements for a WaitHandler.
|
||||
ASIO_WAIT_HANDLER_CHECK(WaitHandler, handler) type_check;
|
||||
|
||||
detail::non_const_lvalue<WaitHandler> handler2(handler);
|
||||
self_->impl_.get_service().async_wait(
|
||||
self_->impl_.get_implementation(),
|
||||
handler2.value, self_->impl_.get_executor());
|
||||
}
|
||||
|
||||
private:
|
||||
basic_object_handle* self_;
|
||||
};
|
||||
|
||||
asio::detail::io_object_impl<
|
||||
asio::detail::win_object_handle_service, Executor> impl_;
|
||||
};
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#include "asio/detail/pop_options.hpp"
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_OBJECT_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_BASIC_OBJECT_HANDLE_HPP
|
||||
455
include/asio/windows/basic_overlapped_handle.hpp
Normal file
455
include/asio/windows/basic_overlapped_handle.hpp
Normal file
@@ -0,0 +1,455 @@
|
||||
//
|
||||
// windows/basic_overlapped_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#ifndef ASIO_WINDOWS_BASIC_OVERLAPPED_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_BASIC_OVERLAPPED_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE) \
|
||||
|| defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include <cstddef>
|
||||
#include <utility>
|
||||
#include "asio/any_io_executor.hpp"
|
||||
#include "asio/async_result.hpp"
|
||||
#include "asio/detail/io_object_impl.hpp"
|
||||
#include "asio/detail/throw_error.hpp"
|
||||
#include "asio/detail/win_iocp_handle_service.hpp"
|
||||
#include "asio/error.hpp"
|
||||
#include "asio/execution_context.hpp"
|
||||
|
||||
#include "asio/detail/push_options.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Provides Windows handle functionality for objects that support
|
||||
/// overlapped I/O.
|
||||
/**
|
||||
* The windows::overlapped_handle class provides the ability to wrap a Windows
|
||||
* handle. The underlying object referred to by the handle must support
|
||||
* overlapped I/O.
|
||||
*
|
||||
* @par Thread Safety
|
||||
* @e Distinct @e objects: Safe.@n
|
||||
* @e Shared @e objects: Unsafe.
|
||||
*/
|
||||
template <typename Executor = any_io_executor>
|
||||
class basic_overlapped_handle
|
||||
{
|
||||
public:
|
||||
/// The type of the executor associated with the object.
|
||||
typedef Executor executor_type;
|
||||
|
||||
/// Rebinds the handle type to another executor.
|
||||
template <typename Executor1>
|
||||
struct rebind_executor
|
||||
{
|
||||
/// The handle type when rebound to the specified executor.
|
||||
typedef basic_overlapped_handle<Executor1> other;
|
||||
};
|
||||
|
||||
/// The native representation of a handle.
|
||||
#if defined(GENERATING_DOCUMENTATION)
|
||||
typedef implementation_defined native_handle_type;
|
||||
#else
|
||||
typedef asio::detail::win_iocp_handle_service::native_handle_type
|
||||
native_handle_type;
|
||||
#endif
|
||||
|
||||
/// An overlapped_handle is always the lowest layer.
|
||||
typedef basic_overlapped_handle lowest_layer_type;
|
||||
|
||||
/// Construct an overlapped handle without opening it.
|
||||
/**
|
||||
* This constructor creates an overlapped handle without opening it.
|
||||
*
|
||||
* @param ex The I/O executor that the overlapped handle will use, by default,
|
||||
* to dispatch handlers for any asynchronous operations performed on the
|
||||
* overlapped handle.
|
||||
*/
|
||||
explicit basic_overlapped_handle(const executor_type& ex)
|
||||
: impl_(0, ex)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct an overlapped handle without opening it.
|
||||
/**
|
||||
* This constructor creates an overlapped handle without opening it.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the overlapped handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the overlapped handle.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
explicit basic_overlapped_handle(ExecutionContext& context,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: impl_(0, 0, context)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct an overlapped handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates an overlapped handle object to hold an existing
|
||||
* native handle.
|
||||
*
|
||||
* @param ex The I/O executor that the overlapped handle will use, by default,
|
||||
* to dispatch handlers for any asynchronous operations performed on the
|
||||
* overlapped handle.
|
||||
*
|
||||
* @param native_handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
basic_overlapped_handle(const executor_type& ex,
|
||||
const native_handle_type& native_handle)
|
||||
: impl_(0, ex)
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().assign(impl_.get_implementation(), native_handle, ec);
|
||||
asio::detail::throw_error(ec, "assign");
|
||||
}
|
||||
|
||||
/// Construct an overlapped handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates an overlapped handle object to hold an existing
|
||||
* native handle.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the overlapped handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the overlapped handle.
|
||||
*
|
||||
* @param native_handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
basic_overlapped_handle(ExecutionContext& context,
|
||||
const native_handle_type& native_handle,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value
|
||||
> = 0)
|
||||
: impl_(0, 0, context)
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().assign(impl_.get_implementation(), native_handle, ec);
|
||||
asio::detail::throw_error(ec, "assign");
|
||||
}
|
||||
|
||||
/// Move-construct an overlapped handle from another.
|
||||
/**
|
||||
* This constructor moves a handle from one object to another.
|
||||
*
|
||||
* @param other The other overlapped handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c overlapped_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_overlapped_handle(basic_overlapped_handle&& other)
|
||||
: impl_(std::move(other.impl_))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign an overlapped handle from another.
|
||||
/**
|
||||
* This assignment operator moves a handle from one object to another.
|
||||
*
|
||||
* @param other The other overlapped handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c overlapped_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_overlapped_handle& operator=(basic_overlapped_handle&& other)
|
||||
{
|
||||
impl_ = std::move(other.impl_);
|
||||
return *this;
|
||||
}
|
||||
|
||||
// All overlapped handles have access to each other's implementations.
|
||||
template <typename Executor1>
|
||||
friend class basic_overlapped_handle;
|
||||
|
||||
/// Move-construct an overlapped handle from a handle of another executor
|
||||
/// type.
|
||||
/**
|
||||
* This constructor moves a handle from one object to another.
|
||||
*
|
||||
* @param other The other overlapped handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c overlapped_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
basic_overlapped_handle(basic_overlapped_handle<Executor1>&& other,
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: impl_(std::move(other.impl_))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign an overlapped handle from a handle of another executor type.
|
||||
/**
|
||||
* This assignment operator moves a handle from one object to another.
|
||||
*
|
||||
* @param other The other overlapped handle object from which the move will
|
||||
* occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c overlapped_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
basic_overlapped_handle&
|
||||
> operator=(basic_overlapped_handle<Executor1>&& other)
|
||||
{
|
||||
impl_ = std::move(other.impl_);
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Get the executor associated with the object.
|
||||
const executor_type& get_executor() noexcept
|
||||
{
|
||||
return impl_.get_executor();
|
||||
}
|
||||
|
||||
/// Get a reference to the lowest layer.
|
||||
/**
|
||||
* This function returns a reference to the lowest layer in a stack of
|
||||
* layers. Since an overlapped_handle cannot contain any further layers, it
|
||||
* simply returns a reference to itself.
|
||||
*
|
||||
* @return A reference to the lowest layer in the stack of layers. Ownership
|
||||
* is not transferred to the caller.
|
||||
*/
|
||||
lowest_layer_type& lowest_layer()
|
||||
{
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Get a const reference to the lowest layer.
|
||||
/**
|
||||
* This function returns a const reference to the lowest layer in a stack of
|
||||
* layers. Since an overlapped_handle cannot contain any further layers, it
|
||||
* simply returns a reference to itself.
|
||||
*
|
||||
* @return A const reference to the lowest layer in the stack of layers.
|
||||
* Ownership is not transferred to the caller.
|
||||
*/
|
||||
const lowest_layer_type& lowest_layer() const
|
||||
{
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Assign an existing native handle to the handle.
|
||||
/*
|
||||
* This function opens the handle to hold an existing native handle.
|
||||
*
|
||||
* @param handle A native handle.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
void assign(const native_handle_type& handle)
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().assign(impl_.get_implementation(), handle, ec);
|
||||
asio::detail::throw_error(ec, "assign");
|
||||
}
|
||||
|
||||
/// Assign an existing native handle to the handle.
|
||||
/*
|
||||
* This function opens the handle to hold an existing native handle.
|
||||
*
|
||||
* @param handle A native handle.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
ASIO_SYNC_OP_VOID assign(const native_handle_type& handle,
|
||||
asio::error_code& ec)
|
||||
{
|
||||
impl_.get_service().assign(impl_.get_implementation(), handle, ec);
|
||||
ASIO_SYNC_OP_VOID_RETURN(ec);
|
||||
}
|
||||
|
||||
/// Determine whether the handle is open.
|
||||
bool is_open() const
|
||||
{
|
||||
return impl_.get_service().is_open(impl_.get_implementation());
|
||||
}
|
||||
|
||||
/// Close the handle.
|
||||
/**
|
||||
* This function is used to close the handle. Any asynchronous read or write
|
||||
* operations will be cancelled immediately, and will complete with the
|
||||
* asio::error::operation_aborted error.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
void close()
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().close(impl_.get_implementation(), ec);
|
||||
asio::detail::throw_error(ec, "close");
|
||||
}
|
||||
|
||||
/// Close the handle.
|
||||
/**
|
||||
* This function is used to close the handle. Any asynchronous read or write
|
||||
* operations will be cancelled immediately, and will complete with the
|
||||
* asio::error::operation_aborted error.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
ASIO_SYNC_OP_VOID close(asio::error_code& ec)
|
||||
{
|
||||
impl_.get_service().close(impl_.get_implementation(), ec);
|
||||
ASIO_SYNC_OP_VOID_RETURN(ec);
|
||||
}
|
||||
|
||||
/// Release ownership of the underlying native handle.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous operations to finish
|
||||
* immediately, and the handlers for cancelled operations will be passed the
|
||||
* asio::error::operation_aborted error. Ownership of the native handle
|
||||
* is then transferred to the caller.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*
|
||||
* @note This function is unsupported on Windows versions prior to Windows
|
||||
* 8.1, and will fail with asio::error::operation_not_supported on
|
||||
* these platforms.
|
||||
*/
|
||||
#if defined(ASIO_MSVC) && (ASIO_MSVC >= 1400) \
|
||||
&& (!defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0603)
|
||||
__declspec(deprecated("This function always fails with "
|
||||
"operation_not_supported when used on Windows versions "
|
||||
"prior to Windows 8.1."))
|
||||
#endif
|
||||
native_handle_type release()
|
||||
{
|
||||
asio::error_code ec;
|
||||
native_handle_type s = impl_.get_service().release(
|
||||
impl_.get_implementation(), ec);
|
||||
asio::detail::throw_error(ec, "release");
|
||||
return s;
|
||||
}
|
||||
|
||||
/// Release ownership of the underlying native handle.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous operations to finish
|
||||
* immediately, and the handlers for cancelled operations will be passed the
|
||||
* asio::error::operation_aborted error. Ownership of the native handle
|
||||
* is then transferred to the caller.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @note This function is unsupported on Windows versions prior to Windows
|
||||
* 8.1, and will fail with asio::error::operation_not_supported on
|
||||
* these platforms.
|
||||
*/
|
||||
#if defined(ASIO_MSVC) && (ASIO_MSVC >= 1400) \
|
||||
&& (!defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0603)
|
||||
__declspec(deprecated("This function always fails with "
|
||||
"operation_not_supported when used on Windows versions "
|
||||
"prior to Windows 8.1."))
|
||||
#endif
|
||||
native_handle_type release(asio::error_code& ec)
|
||||
{
|
||||
return impl_.get_service().release(impl_.get_implementation(), ec);
|
||||
}
|
||||
|
||||
/// Get the native handle representation.
|
||||
/**
|
||||
* This function may be used to obtain the underlying representation of the
|
||||
* handle. This is intended to allow access to native handle functionality
|
||||
* that is not otherwise provided.
|
||||
*/
|
||||
native_handle_type native_handle()
|
||||
{
|
||||
return impl_.get_service().native_handle(impl_.get_implementation());
|
||||
}
|
||||
|
||||
/// Cancel all asynchronous operations associated with the handle.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous read or write operations
|
||||
* to finish immediately, and the handlers for cancelled operations will be
|
||||
* passed the asio::error::operation_aborted error.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
void cancel()
|
||||
{
|
||||
asio::error_code ec;
|
||||
impl_.get_service().cancel(impl_.get_implementation(), ec);
|
||||
asio::detail::throw_error(ec, "cancel");
|
||||
}
|
||||
|
||||
/// Cancel all asynchronous operations associated with the handle.
|
||||
/**
|
||||
* This function causes all outstanding asynchronous read or write operations
|
||||
* to finish immediately, and the handlers for cancelled operations will be
|
||||
* passed the asio::error::operation_aborted error.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*/
|
||||
ASIO_SYNC_OP_VOID cancel(asio::error_code& ec)
|
||||
{
|
||||
impl_.get_service().cancel(impl_.get_implementation(), ec);
|
||||
ASIO_SYNC_OP_VOID_RETURN(ec);
|
||||
}
|
||||
|
||||
protected:
|
||||
/// Protected destructor to prevent deletion through this type.
|
||||
/**
|
||||
* This function destroys the handle, cancelling any outstanding asynchronous
|
||||
* wait operations associated with the handle as if by calling @c cancel.
|
||||
*/
|
||||
~basic_overlapped_handle()
|
||||
{
|
||||
}
|
||||
|
||||
asio::detail::io_object_impl<
|
||||
asio::detail::win_iocp_handle_service, Executor> impl_;
|
||||
|
||||
private:
|
||||
// Disallow copying and assignment.
|
||||
basic_overlapped_handle(const basic_overlapped_handle&) = delete;
|
||||
basic_overlapped_handle& operator=(
|
||||
const basic_overlapped_handle&) = delete;
|
||||
};
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#include "asio/detail/pop_options.hpp"
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE)
|
||||
// || defined(ASIO_HAS_WINDOWS_STREAM_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_BASIC_OVERLAPPED_HANDLE_HPP
|
||||
567
include/asio/windows/basic_random_access_handle.hpp
Normal file
567
include/asio/windows/basic_random_access_handle.hpp
Normal file
@@ -0,0 +1,567 @@
|
||||
//
|
||||
// windows/basic_random_access_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#ifndef ASIO_WINDOWS_BASIC_RANDOM_ACCESS_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_BASIC_RANDOM_ACCESS_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
#include "asio/windows/basic_overlapped_handle.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include "asio/detail/push_options.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Provides random-access handle functionality.
|
||||
/**
|
||||
* The windows::basic_random_access_handle class provides asynchronous and
|
||||
* blocking random-access handle functionality.
|
||||
*
|
||||
* @par Thread Safety
|
||||
* @e Distinct @e objects: Safe.@n
|
||||
* @e Shared @e objects: Unsafe.
|
||||
*/
|
||||
template <typename Executor = any_io_executor>
|
||||
class basic_random_access_handle
|
||||
: public basic_overlapped_handle<Executor>
|
||||
{
|
||||
private:
|
||||
class initiate_async_write_some_at;
|
||||
class initiate_async_read_some_at;
|
||||
|
||||
public:
|
||||
/// The type of the executor associated with the object.
|
||||
typedef Executor executor_type;
|
||||
|
||||
/// Rebinds the handle type to another executor.
|
||||
template <typename Executor1>
|
||||
struct rebind_executor
|
||||
{
|
||||
/// The handle type when rebound to the specified executor.
|
||||
typedef basic_random_access_handle<Executor1> other;
|
||||
};
|
||||
|
||||
/// The native representation of a handle.
|
||||
#if defined(GENERATING_DOCUMENTATION)
|
||||
typedef implementation_defined native_handle_type;
|
||||
#else
|
||||
typedef asio::detail::win_iocp_handle_service::native_handle_type
|
||||
native_handle_type;
|
||||
#endif
|
||||
|
||||
/// Construct a random-access handle without opening it.
|
||||
/**
|
||||
* This constructor creates a random-access handle without opening it.
|
||||
*
|
||||
* @param ex The I/O executor that the random-access handle will use, by
|
||||
* default, to dispatch handlers for any asynchronous operations performed on
|
||||
* the random-access handle.
|
||||
*/
|
||||
explicit basic_random_access_handle(const executor_type& ex)
|
||||
: basic_overlapped_handle<Executor>(ex)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a random-access handle without opening it.
|
||||
/**
|
||||
* This constructor creates a random-access handle without opening it. The
|
||||
* handle needs to be opened or assigned before data can be written to or read
|
||||
* from it.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the random-access handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the random-access handle.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
explicit basic_random_access_handle(ExecutionContext& context,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: basic_overlapped_handle<Executor>(context)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a random-access handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates a random-access handle object to hold an existing
|
||||
* native handle.
|
||||
*
|
||||
* @param ex The I/O executor that the random-access handle will use, by
|
||||
* default, to dispatch handlers for any asynchronous operations performed on
|
||||
* the random-access handle.
|
||||
*
|
||||
* @param handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
basic_random_access_handle(const executor_type& ex,
|
||||
const native_handle_type& handle)
|
||||
: basic_overlapped_handle<Executor>(ex, handle)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a random-access handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates a random-access handle object to hold an existing
|
||||
* native handle.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the random-access handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the random-access handle.
|
||||
*
|
||||
* @param handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
basic_random_access_handle(ExecutionContext& context,
|
||||
const native_handle_type& handle,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value
|
||||
> = 0)
|
||||
: basic_overlapped_handle<Executor>(context, handle)
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-construct a random-access handle from another.
|
||||
/**
|
||||
* This constructor moves a random-access handle from one object to another.
|
||||
*
|
||||
* @param other The other random-access handle object from which the
|
||||
* move will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_random_access_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_random_access_handle(basic_random_access_handle&& other)
|
||||
: basic_overlapped_handle<Executor>(std::move(other))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign a random-access handle from another.
|
||||
/**
|
||||
* This assignment operator moves a random-access handle from one object to
|
||||
* another.
|
||||
*
|
||||
* @param other The other random-access handle object from which the
|
||||
* move will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_random_access_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_random_access_handle& operator=(basic_random_access_handle&& other)
|
||||
{
|
||||
basic_overlapped_handle<Executor>::operator=(std::move(other));
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Move-construct a random-access handle from a handle of another executor
|
||||
/// type.
|
||||
/**
|
||||
* This constructor moves a random-access handle from one object to another.
|
||||
*
|
||||
* @param other The other random-access handle object from which the
|
||||
* move will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_random_access_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
basic_random_access_handle(basic_random_access_handle<Executor1>&& other,
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: basic_overlapped_handle<Executor>(std::move(other))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign a random-access handle from a handle of another executor
|
||||
/// type.
|
||||
/**
|
||||
* This assignment operator moves a random-access handle from one object to
|
||||
* another.
|
||||
*
|
||||
* @param other The other random-access handle object from which the
|
||||
* move will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_random_access_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
basic_random_access_handle&
|
||||
> operator=(basic_random_access_handle<Executor1>&& other)
|
||||
{
|
||||
basic_overlapped_handle<Executor>::operator=(std::move(other));
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Write some data to the handle at the specified offset.
|
||||
/**
|
||||
* This function is used to write data to the random-access handle. The
|
||||
* function call will block until one or more bytes of the data has been
|
||||
* written successfully, or until an error occurs.
|
||||
*
|
||||
* @param offset The offset at which the data will be written.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the handle.
|
||||
*
|
||||
* @returns The number of bytes written.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure. An error code of
|
||||
* asio::error::eof indicates that the connection was closed by the
|
||||
* peer.
|
||||
*
|
||||
* @note The write_some_at operation may not write all of the data. Consider
|
||||
* using the @ref write_at function if you need to ensure that all data is
|
||||
* written before the blocking operation completes.
|
||||
*
|
||||
* @par Example
|
||||
* To write a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.write_some_at(42, asio::buffer(data, size));
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on writing multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename ConstBufferSequence>
|
||||
std::size_t write_some_at(uint64_t offset,
|
||||
const ConstBufferSequence& buffers)
|
||||
{
|
||||
asio::error_code ec;
|
||||
std::size_t s = this->impl_.get_service().write_some_at(
|
||||
this->impl_.get_implementation(), offset, buffers, ec);
|
||||
asio::detail::throw_error(ec, "write_some_at");
|
||||
return s;
|
||||
}
|
||||
|
||||
/// Write some data to the handle at the specified offset.
|
||||
/**
|
||||
* This function is used to write data to the random-access handle. The
|
||||
* function call will block until one or more bytes of the data has been
|
||||
* written successfully, or until an error occurs.
|
||||
*
|
||||
* @param offset The offset at which the data will be written.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the handle.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @returns The number of bytes written. Returns 0 if an error occurred.
|
||||
*
|
||||
* @note The write_some operation may not transmit all of the data to the
|
||||
* peer. Consider using the @ref write_at function if you need to ensure that
|
||||
* all data is written before the blocking operation completes.
|
||||
*/
|
||||
template <typename ConstBufferSequence>
|
||||
std::size_t write_some_at(uint64_t offset,
|
||||
const ConstBufferSequence& buffers, asio::error_code& ec)
|
||||
{
|
||||
return this->impl_.get_service().write_some_at(
|
||||
this->impl_.get_implementation(), offset, buffers, ec);
|
||||
}
|
||||
|
||||
/// Start an asynchronous write at the specified offset.
|
||||
/**
|
||||
* This function is used to asynchronously write data to the random-access
|
||||
* handle. It is an initiating function for an @ref asynchronous_operation,
|
||||
* and always returns immediately.
|
||||
*
|
||||
* @param offset The offset at which the data will be written.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the handle.
|
||||
* Although the buffers object may be copied as necessary, ownership of the
|
||||
* underlying memory blocks is retained by the caller, which must guarantee
|
||||
* that they remain valid until the completion handler is called.
|
||||
*
|
||||
* @param token The @ref completion_token that will be used to produce a
|
||||
* completion handler, which will be called when the write completes.
|
||||
* Potential completion tokens include @ref use_future, @ref use_awaitable,
|
||||
* @ref yield_context, or a function object with the correct completion
|
||||
* signature. The function signature of the completion handler must be:
|
||||
* @code void handler(
|
||||
* const asio::error_code& error, // Result of operation.
|
||||
* std::size_t bytes_transferred // Number of bytes written.
|
||||
* ); @endcode
|
||||
* Regardless of whether the asynchronous operation completes immediately or
|
||||
* not, the completion handler will not be invoked from within this function.
|
||||
* On immediate completion, invocation of the handler will be performed in a
|
||||
* manner equivalent to using asio::async_immediate().
|
||||
*
|
||||
* @par Completion Signature
|
||||
* @code void(asio::error_code, std::size_t) @endcode
|
||||
*
|
||||
* @note The write operation may not transmit all of the data to the peer.
|
||||
* Consider using the @ref async_write_at function if you need to ensure that
|
||||
* all data is written before the asynchronous operation completes.
|
||||
*
|
||||
* @par Example
|
||||
* To write a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.async_write_some_at(42, asio::buffer(data, size), handler);
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on writing multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*
|
||||
* @par Per-Operation Cancellation
|
||||
* This asynchronous operation supports cancellation for the following
|
||||
* asio::cancellation_type values:
|
||||
*
|
||||
* @li @c cancellation_type::terminal
|
||||
*
|
||||
* @li @c cancellation_type::partial
|
||||
*
|
||||
* @li @c cancellation_type::total
|
||||
*/
|
||||
template <typename ConstBufferSequence,
|
||||
ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code,
|
||||
std::size_t)) WriteToken = default_completion_token_t<executor_type>>
|
||||
auto async_write_some_at(uint64_t offset, const ConstBufferSequence& buffers,
|
||||
WriteToken&& token = default_completion_token_t<executor_type>())
|
||||
-> decltype(
|
||||
async_initiate<WriteToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
declval<initiate_async_write_some_at>(), token, offset, buffers))
|
||||
{
|
||||
return async_initiate<WriteToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
initiate_async_write_some_at(this), token, offset, buffers);
|
||||
}
|
||||
|
||||
/// Read some data from the handle at the specified offset.
|
||||
/**
|
||||
* This function is used to read data from the random-access handle. The
|
||||
* function call will block until one or more bytes of data has been read
|
||||
* successfully, or until an error occurs.
|
||||
*
|
||||
* @param offset The offset at which the data will be read.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
*
|
||||
* @returns The number of bytes read.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure. An error code of
|
||||
* asio::error::eof indicates that the connection was closed by the
|
||||
* peer.
|
||||
*
|
||||
* @note The read_some operation may not read all of the requested number of
|
||||
* bytes. Consider using the @ref read_at function if you need to ensure that
|
||||
* the requested amount of data is read before the blocking operation
|
||||
* completes.
|
||||
*
|
||||
* @par Example
|
||||
* To read into a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.read_some_at(42, asio::buffer(data, size));
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on reading into multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename MutableBufferSequence>
|
||||
std::size_t read_some_at(uint64_t offset,
|
||||
const MutableBufferSequence& buffers)
|
||||
{
|
||||
asio::error_code ec;
|
||||
std::size_t s = this->impl_.get_service().read_some_at(
|
||||
this->impl_.get_implementation(), offset, buffers, ec);
|
||||
asio::detail::throw_error(ec, "read_some_at");
|
||||
return s;
|
||||
}
|
||||
|
||||
/// Read some data from the handle at the specified offset.
|
||||
/**
|
||||
* This function is used to read data from the random-access handle. The
|
||||
* function call will block until one or more bytes of data has been read
|
||||
* successfully, or until an error occurs.
|
||||
*
|
||||
* @param offset The offset at which the data will be read.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @returns The number of bytes read. Returns 0 if an error occurred.
|
||||
*
|
||||
* @note The read_some operation may not read all of the requested number of
|
||||
* bytes. Consider using the @ref read_at function if you need to ensure that
|
||||
* the requested amount of data is read before the blocking operation
|
||||
* completes.
|
||||
*/
|
||||
template <typename MutableBufferSequence>
|
||||
std::size_t read_some_at(uint64_t offset,
|
||||
const MutableBufferSequence& buffers, asio::error_code& ec)
|
||||
{
|
||||
return this->impl_.get_service().read_some_at(
|
||||
this->impl_.get_implementation(), offset, buffers, ec);
|
||||
}
|
||||
|
||||
/// Start an asynchronous read at the specified offset.
|
||||
/**
|
||||
* This function is used to asynchronously read data from the random-access
|
||||
* handle. It is an initiating function for an @ref asynchronous_operation,
|
||||
* and always returns immediately.
|
||||
*
|
||||
* @param offset The offset at which the data will be read.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
* Although the buffers object may be copied as necessary, ownership of the
|
||||
* underlying memory blocks is retained by the caller, which must guarantee
|
||||
* that they remain valid until the completion handler is called.
|
||||
*
|
||||
* @param token The @ref completion_token that will be used to produce a
|
||||
* completion handler, which will be called when the read completes.
|
||||
* Potential completion tokens include @ref use_future, @ref use_awaitable,
|
||||
* @ref yield_context, or a function object with the correct completion
|
||||
* signature. The function signature of the completion handler must be:
|
||||
* @code void handler(
|
||||
* const asio::error_code& error, // Result of operation.
|
||||
* std::size_t bytes_transferred // Number of bytes read.
|
||||
* ); @endcode
|
||||
* Regardless of whether the asynchronous operation completes immediately or
|
||||
* not, the completion handler will not be invoked from within this function.
|
||||
* On immediate completion, invocation of the handler will be performed in a
|
||||
* manner equivalent to using asio::async_immediate().
|
||||
*
|
||||
* @par Completion Signature
|
||||
* @code void(asio::error_code, std::size_t) @endcode
|
||||
*
|
||||
* @note The read operation may not read all of the requested number of bytes.
|
||||
* Consider using the @ref async_read_at function if you need to ensure that
|
||||
* the requested amount of data is read before the asynchronous operation
|
||||
* completes.
|
||||
*
|
||||
* @par Example
|
||||
* To read into a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.async_read_some_at(42, asio::buffer(data, size), handler);
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on reading into multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*
|
||||
* @par Per-Operation Cancellation
|
||||
* This asynchronous operation supports cancellation for the following
|
||||
* asio::cancellation_type values:
|
||||
*
|
||||
* @li @c cancellation_type::terminal
|
||||
*
|
||||
* @li @c cancellation_type::partial
|
||||
*
|
||||
* @li @c cancellation_type::total
|
||||
*/
|
||||
template <typename MutableBufferSequence,
|
||||
ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code,
|
||||
std::size_t)) ReadToken = default_completion_token_t<executor_type>>
|
||||
auto async_read_some_at(uint64_t offset, const MutableBufferSequence& buffers,
|
||||
ReadToken&& token = default_completion_token_t<executor_type>())
|
||||
-> decltype(
|
||||
async_initiate<ReadToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
declval<initiate_async_read_some_at>(), token, offset, buffers))
|
||||
{
|
||||
return async_initiate<ReadToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
initiate_async_read_some_at(this), token, offset, buffers);
|
||||
}
|
||||
|
||||
private:
|
||||
class initiate_async_write_some_at
|
||||
{
|
||||
public:
|
||||
typedef Executor executor_type;
|
||||
|
||||
explicit initiate_async_write_some_at(basic_random_access_handle* self)
|
||||
: self_(self)
|
||||
{
|
||||
}
|
||||
|
||||
const executor_type& get_executor() const noexcept
|
||||
{
|
||||
return self_->get_executor();
|
||||
}
|
||||
|
||||
template <typename WriteHandler, typename ConstBufferSequence>
|
||||
void operator()(WriteHandler&& handler,
|
||||
uint64_t offset, const ConstBufferSequence& buffers) const
|
||||
{
|
||||
// If you get an error on the following line it means that your handler
|
||||
// does not meet the documented type requirements for a WriteHandler.
|
||||
ASIO_WRITE_HANDLER_CHECK(WriteHandler, handler) type_check;
|
||||
|
||||
detail::non_const_lvalue<WriteHandler> handler2(handler);
|
||||
self_->impl_.get_service().async_write_some_at(
|
||||
self_->impl_.get_implementation(), offset, buffers,
|
||||
handler2.value, self_->impl_.get_executor());
|
||||
}
|
||||
|
||||
private:
|
||||
basic_random_access_handle* self_;
|
||||
};
|
||||
|
||||
class initiate_async_read_some_at
|
||||
{
|
||||
public:
|
||||
typedef Executor executor_type;
|
||||
|
||||
explicit initiate_async_read_some_at(basic_random_access_handle* self)
|
||||
: self_(self)
|
||||
{
|
||||
}
|
||||
|
||||
const executor_type& get_executor() const noexcept
|
||||
{
|
||||
return self_->get_executor();
|
||||
}
|
||||
|
||||
template <typename ReadHandler, typename MutableBufferSequence>
|
||||
void operator()(ReadHandler&& handler,
|
||||
uint64_t offset, const MutableBufferSequence& buffers) const
|
||||
{
|
||||
// If you get an error on the following line it means that your handler
|
||||
// does not meet the documented type requirements for a ReadHandler.
|
||||
ASIO_READ_HANDLER_CHECK(ReadHandler, handler) type_check;
|
||||
|
||||
detail::non_const_lvalue<ReadHandler> handler2(handler);
|
||||
self_->impl_.get_service().async_read_some_at(
|
||||
self_->impl_.get_implementation(), offset, buffers,
|
||||
handler2.value, self_->impl_.get_executor());
|
||||
}
|
||||
|
||||
private:
|
||||
basic_random_access_handle* self_;
|
||||
};
|
||||
};
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#include "asio/detail/pop_options.hpp"
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_BASIC_RANDOM_ACCESS_HANDLE_HPP
|
||||
551
include/asio/windows/basic_stream_handle.hpp
Normal file
551
include/asio/windows/basic_stream_handle.hpp
Normal file
@@ -0,0 +1,551 @@
|
||||
//
|
||||
// windows/basic_stream_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#ifndef ASIO_WINDOWS_BASIC_STREAM_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_BASIC_STREAM_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
#include "asio/windows/basic_overlapped_handle.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include "asio/detail/push_options.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Provides stream-oriented handle functionality.
|
||||
/**
|
||||
* The windows::basic_stream_handle class provides asynchronous and blocking
|
||||
* stream-oriented handle functionality.
|
||||
*
|
||||
* @par Thread Safety
|
||||
* @e Distinct @e objects: Safe.@n
|
||||
* @e Shared @e objects: Unsafe.
|
||||
*
|
||||
* @par Concepts:
|
||||
* AsyncReadStream, AsyncWriteStream, Stream, SyncReadStream, SyncWriteStream.
|
||||
*/
|
||||
template <typename Executor = any_io_executor>
|
||||
class basic_stream_handle
|
||||
: public basic_overlapped_handle<Executor>
|
||||
{
|
||||
private:
|
||||
class initiate_async_write_some;
|
||||
class initiate_async_read_some;
|
||||
|
||||
public:
|
||||
/// The type of the executor associated with the object.
|
||||
typedef Executor executor_type;
|
||||
|
||||
/// Rebinds the handle type to another executor.
|
||||
template <typename Executor1>
|
||||
struct rebind_executor
|
||||
{
|
||||
/// The handle type when rebound to the specified executor.
|
||||
typedef basic_stream_handle<Executor1> other;
|
||||
};
|
||||
|
||||
/// The native representation of a handle.
|
||||
#if defined(GENERATING_DOCUMENTATION)
|
||||
typedef implementation_defined native_handle_type;
|
||||
#else
|
||||
typedef asio::detail::win_iocp_handle_service::native_handle_type
|
||||
native_handle_type;
|
||||
#endif
|
||||
|
||||
/// Construct a stream handle without opening it.
|
||||
/**
|
||||
* This constructor creates a stream handle without opening it.
|
||||
*
|
||||
* @param ex The I/O executor that the stream handle will use, by default, to
|
||||
* dispatch handlers for any asynchronous operations performed on the stream
|
||||
* handle.
|
||||
*/
|
||||
explicit basic_stream_handle(const executor_type& ex)
|
||||
: basic_overlapped_handle<Executor>(ex)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a stream handle without opening it.
|
||||
/**
|
||||
* This constructor creates a stream handle without opening it. The handle
|
||||
* needs to be opened or assigned before data can be written to or read from
|
||||
* it.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the stream handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the stream handle.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
explicit basic_stream_handle(ExecutionContext& context,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: basic_overlapped_handle<Executor>(context)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a stream handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates a stream handle object to hold an existing native
|
||||
* handle.
|
||||
*
|
||||
* @param ex The I/O executor that the stream handle will use, by default, to
|
||||
* dispatch handlers for any asynchronous operations performed on the stream
|
||||
* handle.
|
||||
*
|
||||
* @param handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
basic_stream_handle(const executor_type& ex, const native_handle_type& handle)
|
||||
: basic_overlapped_handle<Executor>(ex, handle)
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct a stream handle on an existing native handle.
|
||||
/**
|
||||
* This constructor creates a stream handle object to hold an existing native
|
||||
* handle.
|
||||
*
|
||||
* @param context An execution context which provides the I/O executor that
|
||||
* the stream handle will use, by default, to dispatch handlers for any
|
||||
* asynchronous operations performed on the stream handle.
|
||||
*
|
||||
* @param handle The new underlying handle implementation.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure.
|
||||
*/
|
||||
template <typename ExecutionContext>
|
||||
basic_stream_handle(ExecutionContext& context,
|
||||
const native_handle_type& handle,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value
|
||||
> = 0)
|
||||
: basic_overlapped_handle<Executor>(context, handle)
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-construct a stream handle from another.
|
||||
/**
|
||||
* This constructor moves a stream handle from one object to another.
|
||||
*
|
||||
* @param other The other stream handle object from which the move
|
||||
* will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_stream_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_stream_handle(basic_stream_handle&& other)
|
||||
: basic_overlapped_handle<Executor>(std::move(other))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign a stream handle from another.
|
||||
/**
|
||||
* This assignment operator moves a stream handle from one object to
|
||||
* another.
|
||||
*
|
||||
* @param other The other stream handle object from which the move will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_stream_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
basic_stream_handle& operator=(basic_stream_handle&& other)
|
||||
{
|
||||
basic_overlapped_handle<Executor>::operator=(std::move(other));
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Move-construct a stream handle from a handle of another executor type.
|
||||
/**
|
||||
* This constructor moves a stream handle from one object to another.
|
||||
*
|
||||
* @param other The other stream handle object from which the move
|
||||
* will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_stream_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
basic_stream_handle(basic_stream_handle<Executor1>&& other,
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
defaulted_constraint
|
||||
> = defaulted_constraint())
|
||||
: basic_overlapped_handle<Executor>(std::move(other))
|
||||
{
|
||||
}
|
||||
|
||||
/// Move-assign a stream handle from a handle of another executor type.
|
||||
/**
|
||||
* This assignment operator moves a stream handle from one object to
|
||||
* another.
|
||||
*
|
||||
* @param other The other stream handle object from which the move will occur.
|
||||
*
|
||||
* @note Following the move, the moved-from object is in the same state as if
|
||||
* constructed using the @c basic_stream_handle(const executor_type&)
|
||||
* constructor.
|
||||
*/
|
||||
template<typename Executor1>
|
||||
constraint_t<
|
||||
is_convertible<Executor1, Executor>::value,
|
||||
basic_stream_handle&
|
||||
> operator=(basic_stream_handle<Executor1>&& other)
|
||||
{
|
||||
basic_overlapped_handle<Executor>::operator=(std::move(other));
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// Write some data to the handle.
|
||||
/**
|
||||
* This function is used to write data to the stream handle. The function call
|
||||
* will block until one or more bytes of the data has been written
|
||||
* successfully, or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the handle.
|
||||
*
|
||||
* @returns The number of bytes written.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure. An error code of
|
||||
* asio::error::eof indicates that the connection was closed by the
|
||||
* peer.
|
||||
*
|
||||
* @note The write_some operation may not transmit all of the data to the
|
||||
* peer. Consider using the @ref write function if you need to ensure that
|
||||
* all data is written before the blocking operation completes.
|
||||
*
|
||||
* @par Example
|
||||
* To write a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.write_some(asio::buffer(data, size));
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on writing multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename ConstBufferSequence>
|
||||
std::size_t write_some(const ConstBufferSequence& buffers)
|
||||
{
|
||||
asio::error_code ec;
|
||||
std::size_t s = this->impl_.get_service().write_some(
|
||||
this->impl_.get_implementation(), buffers, ec);
|
||||
asio::detail::throw_error(ec, "write_some");
|
||||
return s;
|
||||
}
|
||||
|
||||
/// Write some data to the handle.
|
||||
/**
|
||||
* This function is used to write data to the stream handle. The function call
|
||||
* will block until one or more bytes of the data has been written
|
||||
* successfully, or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the handle.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @returns The number of bytes written. Returns 0 if an error occurred.
|
||||
*
|
||||
* @note The write_some operation may not transmit all of the data to the
|
||||
* peer. Consider using the @ref write function if you need to ensure that
|
||||
* all data is written before the blocking operation completes.
|
||||
*/
|
||||
template <typename ConstBufferSequence>
|
||||
std::size_t write_some(const ConstBufferSequence& buffers,
|
||||
asio::error_code& ec)
|
||||
{
|
||||
return this->impl_.get_service().write_some(
|
||||
this->impl_.get_implementation(), buffers, ec);
|
||||
}
|
||||
|
||||
/// Start an asynchronous write.
|
||||
/**
|
||||
* This function is used to asynchronously write data to the stream handle.
|
||||
* It is an initiating function for an @ref asynchronous_operation, and always
|
||||
* returns immediately.
|
||||
*
|
||||
* @param buffers One or more data buffers to be written to the handle.
|
||||
* Although the buffers object may be copied as necessary, ownership of the
|
||||
* underlying memory blocks is retained by the caller, which must guarantee
|
||||
* that they remain valid until the completion handler is called.
|
||||
*
|
||||
* @param token The @ref completion_token that will be used to produce a
|
||||
* completion handler, which will be called when the write completes.
|
||||
* Potential completion tokens include @ref use_future, @ref use_awaitable,
|
||||
* @ref yield_context, or a function object with the correct completion
|
||||
* signature. The function signature of the completion handler must be:
|
||||
* @code void handler(
|
||||
* const asio::error_code& error, // Result of operation.
|
||||
* std::size_t bytes_transferred // Number of bytes written.
|
||||
* ); @endcode
|
||||
* Regardless of whether the asynchronous operation completes immediately or
|
||||
* not, the completion handler will not be invoked from within this function.
|
||||
* On immediate completion, invocation of the handler will be performed in a
|
||||
* manner equivalent to using asio::async_immediate().
|
||||
*
|
||||
* @par Completion Signature
|
||||
* @code void(asio::error_code, std::size_t) @endcode
|
||||
*
|
||||
* @note The write operation may not transmit all of the data to the peer.
|
||||
* Consider using the @ref async_write function if you need to ensure that all
|
||||
* data is written before the asynchronous operation completes.
|
||||
*
|
||||
* @par Example
|
||||
* To write a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.async_write_some(asio::buffer(data, size), handler);
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on writing multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*
|
||||
* @par Per-Operation Cancellation
|
||||
* This asynchronous operation supports cancellation for the following
|
||||
* asio::cancellation_type values:
|
||||
*
|
||||
* @li @c cancellation_type::terminal
|
||||
*
|
||||
* @li @c cancellation_type::partial
|
||||
*
|
||||
* @li @c cancellation_type::total
|
||||
*/
|
||||
template <typename ConstBufferSequence,
|
||||
ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code,
|
||||
std::size_t)) WriteToken = default_completion_token_t<executor_type>>
|
||||
auto async_write_some(const ConstBufferSequence& buffers,
|
||||
WriteToken&& token = default_completion_token_t<executor_type>())
|
||||
-> decltype(
|
||||
async_initiate<WriteToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
declval<initiate_async_write_some>(), token, buffers))
|
||||
{
|
||||
return async_initiate<WriteToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
initiate_async_write_some(this), token, buffers);
|
||||
}
|
||||
|
||||
/// Read some data from the handle.
|
||||
/**
|
||||
* This function is used to read data from the stream handle. The function
|
||||
* call will block until one or more bytes of data has been read successfully,
|
||||
* or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
*
|
||||
* @returns The number of bytes read.
|
||||
*
|
||||
* @throws asio::system_error Thrown on failure. An error code of
|
||||
* asio::error::eof indicates that the connection was closed by the
|
||||
* peer.
|
||||
*
|
||||
* @note The read_some operation may not read all of the requested number of
|
||||
* bytes. Consider using the @ref read function if you need to ensure that
|
||||
* the requested amount of data is read before the blocking operation
|
||||
* completes.
|
||||
*
|
||||
* @par Example
|
||||
* To read into a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.read_some(asio::buffer(data, size));
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on reading into multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*/
|
||||
template <typename MutableBufferSequence>
|
||||
std::size_t read_some(const MutableBufferSequence& buffers)
|
||||
{
|
||||
asio::error_code ec;
|
||||
std::size_t s = this->impl_.get_service().read_some(
|
||||
this->impl_.get_implementation(), buffers, ec);
|
||||
asio::detail::throw_error(ec, "read_some");
|
||||
return s;
|
||||
}
|
||||
|
||||
/// Read some data from the handle.
|
||||
/**
|
||||
* This function is used to read data from the stream handle. The function
|
||||
* call will block until one or more bytes of data has been read successfully,
|
||||
* or until an error occurs.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
*
|
||||
* @param ec Set to indicate what error occurred, if any.
|
||||
*
|
||||
* @returns The number of bytes read. Returns 0 if an error occurred.
|
||||
*
|
||||
* @note The read_some operation may not read all of the requested number of
|
||||
* bytes. Consider using the @ref read function if you need to ensure that
|
||||
* the requested amount of data is read before the blocking operation
|
||||
* completes.
|
||||
*/
|
||||
template <typename MutableBufferSequence>
|
||||
std::size_t read_some(const MutableBufferSequence& buffers,
|
||||
asio::error_code& ec)
|
||||
{
|
||||
return this->impl_.get_service().read_some(
|
||||
this->impl_.get_implementation(), buffers, ec);
|
||||
}
|
||||
|
||||
/// Start an asynchronous read.
|
||||
/**
|
||||
* This function is used to asynchronously read data from the stream handle.
|
||||
* It is an initiating function for an @ref asynchronous_operation, and always
|
||||
* returns immediately.
|
||||
*
|
||||
* @param buffers One or more buffers into which the data will be read.
|
||||
* Although the buffers object may be copied as necessary, ownership of the
|
||||
* underlying memory blocks is retained by the caller, which must guarantee
|
||||
* that they remain valid until the completion handler is called.
|
||||
*
|
||||
* @param token The @ref completion_token that will be used to produce a
|
||||
* completion handler, which will be called when the read completes.
|
||||
* Potential completion tokens include @ref use_future, @ref use_awaitable,
|
||||
* @ref yield_context, or a function object with the correct completion
|
||||
* signature. The function signature of the completion handler must be:
|
||||
* @code void handler(
|
||||
* const asio::error_code& error, // Result of operation.
|
||||
* std::size_t bytes_transferred // Number of bytes read.
|
||||
* ); @endcode
|
||||
* Regardless of whether the asynchronous operation completes immediately or
|
||||
* not, the completion handler will not be invoked from within this function.
|
||||
* On immediate completion, invocation of the handler will be performed in a
|
||||
* manner equivalent to using asio::async_immediate().
|
||||
*
|
||||
* @par Completion Signature
|
||||
* @code void(asio::error_code, std::size_t) @endcode
|
||||
*
|
||||
* @note The read operation may not read all of the requested number of bytes.
|
||||
* Consider using the @ref async_read function if you need to ensure that the
|
||||
* requested amount of data is read before the asynchronous operation
|
||||
* completes.
|
||||
*
|
||||
* @par Example
|
||||
* To read into a single data buffer use the @ref buffer function as follows:
|
||||
* @code
|
||||
* handle.async_read_some(asio::buffer(data, size), handler);
|
||||
* @endcode
|
||||
* See the @ref buffer documentation for information on reading into multiple
|
||||
* buffers in one go, and how to use it with arrays, boost::array or
|
||||
* std::vector.
|
||||
*
|
||||
* @par Per-Operation Cancellation
|
||||
* This asynchronous operation supports cancellation for the following
|
||||
* asio::cancellation_type values:
|
||||
*
|
||||
* @li @c cancellation_type::terminal
|
||||
*
|
||||
* @li @c cancellation_type::partial
|
||||
*
|
||||
* @li @c cancellation_type::total
|
||||
*/
|
||||
template <typename MutableBufferSequence,
|
||||
ASIO_COMPLETION_TOKEN_FOR(void (asio::error_code,
|
||||
std::size_t)) ReadToken = default_completion_token_t<executor_type>>
|
||||
auto async_read_some(const MutableBufferSequence& buffers,
|
||||
ReadToken&& token = default_completion_token_t<executor_type>())
|
||||
-> decltype(
|
||||
async_initiate<ReadToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
declval<initiate_async_read_some>(), token, buffers))
|
||||
{
|
||||
return async_initiate<ReadToken,
|
||||
void (asio::error_code, std::size_t)>(
|
||||
initiate_async_read_some(this), token, buffers);
|
||||
}
|
||||
|
||||
private:
|
||||
class initiate_async_write_some
|
||||
{
|
||||
public:
|
||||
typedef Executor executor_type;
|
||||
|
||||
explicit initiate_async_write_some(basic_stream_handle* self)
|
||||
: self_(self)
|
||||
{
|
||||
}
|
||||
|
||||
const executor_type& get_executor() const noexcept
|
||||
{
|
||||
return self_->get_executor();
|
||||
}
|
||||
|
||||
template <typename WriteHandler, typename ConstBufferSequence>
|
||||
void operator()(WriteHandler&& handler,
|
||||
const ConstBufferSequence& buffers) const
|
||||
{
|
||||
// If you get an error on the following line it means that your handler
|
||||
// does not meet the documented type requirements for a WriteHandler.
|
||||
ASIO_WRITE_HANDLER_CHECK(WriteHandler, handler) type_check;
|
||||
|
||||
detail::non_const_lvalue<WriteHandler> handler2(handler);
|
||||
self_->impl_.get_service().async_write_some(
|
||||
self_->impl_.get_implementation(), buffers,
|
||||
handler2.value, self_->impl_.get_executor());
|
||||
}
|
||||
|
||||
private:
|
||||
basic_stream_handle* self_;
|
||||
};
|
||||
|
||||
class initiate_async_read_some
|
||||
{
|
||||
public:
|
||||
typedef Executor executor_type;
|
||||
|
||||
explicit initiate_async_read_some(basic_stream_handle* self)
|
||||
: self_(self)
|
||||
{
|
||||
}
|
||||
|
||||
const executor_type& get_executor() const noexcept
|
||||
{
|
||||
return self_->get_executor();
|
||||
}
|
||||
|
||||
template <typename ReadHandler, typename MutableBufferSequence>
|
||||
void operator()(ReadHandler&& handler,
|
||||
const MutableBufferSequence& buffers) const
|
||||
{
|
||||
// If you get an error on the following line it means that your handler
|
||||
// does not meet the documented type requirements for a ReadHandler.
|
||||
ASIO_READ_HANDLER_CHECK(ReadHandler, handler) type_check;
|
||||
|
||||
detail::non_const_lvalue<ReadHandler> handler2(handler);
|
||||
self_->impl_.get_service().async_read_some(
|
||||
self_->impl_.get_implementation(), buffers,
|
||||
handler2.value, self_->impl_.get_executor());
|
||||
}
|
||||
|
||||
private:
|
||||
basic_stream_handle* self_;
|
||||
};
|
||||
};
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#include "asio/detail/pop_options.hpp"
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_STREAM_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_BASIC_STREAM_HANDLE_HPP
|
||||
38
include/asio/windows/object_handle.hpp
Normal file
38
include/asio/windows/object_handle.hpp
Normal file
@@ -0,0 +1,38 @@
|
||||
//
|
||||
// windows/object_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
|
||||
// Copyright (c) 2011 Boris Schaeling (boris@highscore.de)
|
||||
//
|
||||
// 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 ASIO_WINDOWS_OBJECT_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_OBJECT_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include "asio/windows/basic_object_handle.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Typedef for the typical usage of an object handle.
|
||||
typedef basic_object_handle<> object_handle;
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_OBJECT_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_OBJECT_HANDLE_HPP
|
||||
39
include/asio/windows/overlapped_handle.hpp
Normal file
39
include/asio/windows/overlapped_handle.hpp
Normal file
@@ -0,0 +1,39 @@
|
||||
//
|
||||
// windows/overlapped_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#ifndef ASIO_WINDOWS_OVERLAPPED_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_OVERLAPPED_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE) \
|
||||
|| defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include "asio/windows/basic_overlapped_handle.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Typedef for the typical usage of an overlapped handle.
|
||||
typedef basic_overlapped_handle<> overlapped_handle;
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE)
|
||||
// || defined(ASIO_HAS_WINDOWS_STREAM_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_OVERLAPPED_HANDLE_HPP
|
||||
145
include/asio/windows/overlapped_ptr.hpp
Normal file
145
include/asio/windows/overlapped_ptr.hpp
Normal file
@@ -0,0 +1,145 @@
|
||||
//
|
||||
// windows/overlapped_ptr.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#ifndef ASIO_WINDOWS_OVERLAPPED_PTR_HPP
|
||||
#define ASIO_WINDOWS_OVERLAPPED_PTR_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_OVERLAPPED_PTR) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include "asio/detail/noncopyable.hpp"
|
||||
#include "asio/detail/win_iocp_overlapped_ptr.hpp"
|
||||
#include "asio/io_context.hpp"
|
||||
|
||||
#include "asio/detail/push_options.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Wraps a handler to create an OVERLAPPED object for use with overlapped I/O.
|
||||
/**
|
||||
* A special-purpose smart pointer used to wrap an application handler so that
|
||||
* it can be passed as the LPOVERLAPPED argument to overlapped I/O functions.
|
||||
*
|
||||
* @par Thread Safety
|
||||
* @e Distinct @e objects: Safe.@n
|
||||
* @e Shared @e objects: Unsafe.
|
||||
*/
|
||||
class overlapped_ptr
|
||||
: private noncopyable
|
||||
{
|
||||
public:
|
||||
/// Construct an empty overlapped_ptr.
|
||||
overlapped_ptr()
|
||||
: impl_()
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct an overlapped_ptr to contain the specified handler.
|
||||
template <typename ExecutionContext, typename Handler>
|
||||
explicit overlapped_ptr(ExecutionContext& context,
|
||||
Handler&& handler,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value
|
||||
> = 0)
|
||||
: impl_(context.get_executor(), static_cast<Handler&&>(handler))
|
||||
{
|
||||
}
|
||||
|
||||
/// Construct an overlapped_ptr to contain the specified handler.
|
||||
template <typename Executor, typename Handler>
|
||||
explicit overlapped_ptr(const Executor& ex,
|
||||
Handler&& handler,
|
||||
constraint_t<
|
||||
execution::is_executor<Executor>::value
|
||||
|| is_executor<Executor>::value
|
||||
> = 0)
|
||||
: impl_(ex, static_cast<Handler&&>(handler))
|
||||
{
|
||||
}
|
||||
|
||||
/// Destructor automatically frees the OVERLAPPED object unless released.
|
||||
~overlapped_ptr()
|
||||
{
|
||||
}
|
||||
|
||||
/// Reset to empty.
|
||||
void reset()
|
||||
{
|
||||
impl_.reset();
|
||||
}
|
||||
|
||||
/// Reset to contain the specified handler, freeing any current OVERLAPPED
|
||||
/// object.
|
||||
template <typename ExecutionContext, typename Handler>
|
||||
void reset(ExecutionContext& context, Handler&& handler,
|
||||
constraint_t<
|
||||
is_convertible<ExecutionContext&, execution_context&>::value
|
||||
> = 0)
|
||||
{
|
||||
impl_.reset(context.get_executor(), static_cast<Handler&&>(handler));
|
||||
}
|
||||
|
||||
/// Reset to contain the specified handler, freeing any current OVERLAPPED
|
||||
/// object.
|
||||
template <typename Executor, typename Handler>
|
||||
void reset(const Executor& ex, Handler&& handler,
|
||||
constraint_t<
|
||||
execution::is_executor<Executor>::value
|
||||
|| is_executor<Executor>::value
|
||||
> = 0)
|
||||
{
|
||||
impl_.reset(ex, static_cast<Handler&&>(handler));
|
||||
}
|
||||
|
||||
/// Get the contained OVERLAPPED object.
|
||||
OVERLAPPED* get()
|
||||
{
|
||||
return impl_.get();
|
||||
}
|
||||
|
||||
/// Get the contained OVERLAPPED object.
|
||||
const OVERLAPPED* get() const
|
||||
{
|
||||
return impl_.get();
|
||||
}
|
||||
|
||||
/// Release ownership of the OVERLAPPED object.
|
||||
OVERLAPPED* release()
|
||||
{
|
||||
return impl_.release();
|
||||
}
|
||||
|
||||
/// Post completion notification for overlapped operation. Releases ownership.
|
||||
void complete(const asio::error_code& ec,
|
||||
std::size_t bytes_transferred)
|
||||
{
|
||||
impl_.complete(ec, bytes_transferred);
|
||||
}
|
||||
|
||||
private:
|
||||
detail::win_iocp_overlapped_ptr impl_;
|
||||
};
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#include "asio/detail/pop_options.hpp"
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_OVERLAPPED_PTR)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_OVERLAPPED_PTR_HPP
|
||||
37
include/asio/windows/random_access_handle.hpp
Normal file
37
include/asio/windows/random_access_handle.hpp
Normal file
@@ -0,0 +1,37 @@
|
||||
//
|
||||
// windows/random_access_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#ifndef ASIO_WINDOWS_RANDOM_ACCESS_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_RANDOM_ACCESS_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include "asio/windows/basic_random_access_handle.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Typedef for the typical usage of a random-access handle.
|
||||
typedef basic_random_access_handle<> random_access_handle;
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_RANDOM_ACCESS_HANDLE_HPP
|
||||
37
include/asio/windows/stream_handle.hpp
Normal file
37
include/asio/windows/stream_handle.hpp
Normal file
@@ -0,0 +1,37 @@
|
||||
//
|
||||
// windows/stream_handle.hpp
|
||||
// ~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
//
|
||||
// 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)
|
||||
//
|
||||
|
||||
#ifndef ASIO_WINDOWS_STREAM_HANDLE_HPP
|
||||
#define ASIO_WINDOWS_STREAM_HANDLE_HPP
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
# pragma once
|
||||
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||||
|
||||
#include "asio/detail/config.hpp"
|
||||
|
||||
#if defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) \
|
||||
|| defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#include "asio/windows/basic_stream_handle.hpp"
|
||||
|
||||
namespace asio {
|
||||
namespace windows {
|
||||
|
||||
/// Typedef for the typical usage of a stream-oriented handle.
|
||||
typedef basic_stream_handle<> stream_handle;
|
||||
|
||||
} // namespace windows
|
||||
} // namespace asio
|
||||
|
||||
#endif // defined(ASIO_HAS_WINDOWS_STREAM_HANDLE)
|
||||
// || defined(GENERATING_DOCUMENTATION)
|
||||
|
||||
#endif // ASIO_WINDOWS_STREAM_HANDLE_HPP
|
||||
Reference in New Issue
Block a user