asio/include/asio/windows/basic_handle.hpp - third_party/asio - Git at Google

 //
 // windows/basic_handle.hpp
 // ~~~~~~~~~~~~~~~~~~~~~~~~
 //
 // Copyright (c) 2003-2016 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_HANDLE_HPP
 #define ASIO_WINDOWS_BASIC_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_ENABLE_OLD_SERVICES)

 #if defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE) \
   || defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) \
   || defined(ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
   || defined(GENERATING_DOCUMENTATION)

 #include "asio/basic_io_object.hpp"
 #include "asio/detail/throw_error.hpp"
 #include "asio/error.hpp"

 #include "asio/detail/push_options.hpp"

 namespace asio {
 namespace windows {

 /// Provides Windows handle functionality.
 /**
  * The windows::basic_handle class template provides the ability to wrap a
  * Windows handle.
  *
  * @par Thread Safety
  * @e Distinct @e objects: Safe.@n
  * @e Shared @e objects: Unsafe.
  */
 template <typename HandleService>
 class basic_handle
   : public basic_io_object<HandleService>
 {
 public:
   /// The native representation of a handle.
   typedef typename HandleService::native_handle_type native_handle_type;

   /// A basic_handle is always the lowest layer.
   typedef basic_handle<HandleService> lowest_layer_type;

   /// Construct a basic_handle without opening it.
   /**
    * This constructor creates a handle without opening it.
    *
    * @param io_context The io_context object that the handle will use to
    * dispatch handlers for any asynchronous operations performed on the handle.
    */
   explicit basic_handle(asio::io_context& io_context)
     : basic_io_object<HandleService>(io_context)
   {
   }

   /// Construct a basic_handle on an existing native handle.
   /**
    * This constructor creates a handle object to hold an existing native handle.
    *
    * @param io_context The io_context object that the handle will use to
    * dispatch handlers for any asynchronous operations performed on the handle.
    *
    * @param handle A native handle.
    *
    * @throws asio::system_error Thrown on failure.
    */
   basic_handle(asio::io_context& io_context,
       const native_handle_type& handle)
     : basic_io_object<HandleService>(io_context)
   {
     asio::error_code ec;
     this->get_service().assign(this->get_implementation(), handle, ec);
     asio::detail::throw_error(ec, "assign");
   }

 #if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
   /// Move-construct a basic_handle from another.
   /**
    * This constructor moves a handle from one object to another.
    *
    * @param other The other basic_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_handle(io_context&) constructor.
    */
   basic_handle(basic_handle&& other)
     : basic_io_object<HandleService>(
         ASIO_MOVE_CAST(basic_handle)(other))
   {
   }

   /// Move-assign a basic_handle from another.
   /**
    * This assignment operator moves a handle from one object to another.
    *
    * @param other The other basic_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_handle(io_context&) constructor.
    */
   basic_handle& operator=(basic_handle&& other)
   {
     basic_io_object<HandleService>::operator=(
         ASIO_MOVE_CAST(basic_handle)(other));
     return *this;
   }
 #endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)

   /// Get a reference to the lowest layer.
   /**
    * This function returns a reference to the lowest layer in a stack of
    * layers. Since a basic_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 a basic_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;
     this->get_service().assign(this->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)
   {
     this->get_service().assign(this->get_implementation(), handle, ec);
     ASIO_SYNC_OP_VOID_RETURN(ec);
   }

   /// Determine whether the handle is open.
   bool is_open() const
   {
     return this->get_service().is_open(this->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;
     this->get_service().close(this->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)
   {
     this->get_service().close(this->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 this->get_service().native_handle(this->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;
     this->get_service().cancel(this->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)
   {
     this->get_service().cancel(this->get_implementation(), ec);
     ASIO_SYNC_OP_VOID_RETURN(ec);
   }

 protected:
   /// Protected destructor to prevent deletion through this type.
   ~basic_handle()
   {
   }
 };

 } // 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(ASIO_HAS_WINDOWS_OBJECT_HANDLE)
        //   || defined(GENERATING_DOCUMENTATION)

 #endif // defined(ASIO_ENABLE_OLD_SERVICES)

 #endif // ASIO_WINDOWS_BASIC_HANDLE_HPP
	//
	// windows/basic_handle.hpp
	// ~~~~~~~~~~~~~~~~~~~~~~~~
	//
	// Copyright (c) 2003-2016 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_HANDLE_HPP
	#define ASIO_WINDOWS_BASIC_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_ENABLE_OLD_SERVICES)

	#if defined(ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE) \
	\|\| defined(ASIO_HAS_WINDOWS_STREAM_HANDLE) \
	\|\| defined(ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
	\|\| defined(GENERATING_DOCUMENTATION)

	#include "asio/basic_io_object.hpp"
	#include "asio/detail/throw_error.hpp"
	#include "asio/error.hpp"

	#include "asio/detail/push_options.hpp"

	namespace asio {
	namespace windows {

	/// Provides Windows handle functionality.
	/**
	* The windows::basic_handle class template provides the ability to wrap a
	* Windows handle.
	*
	* @par Thread Safety
	* @e Distinct @e objects: Safe.@n
	* @e Shared @e objects: Unsafe.
	*/
	template <typename HandleService>
	class basic_handle
	: public basic_io_object<HandleService>
	{
	public:
	/// The native representation of a handle.
	typedef typename HandleService::native_handle_type native_handle_type;

	/// A basic_handle is always the lowest layer.
	typedef basic_handle<HandleService> lowest_layer_type;

	/// Construct a basic_handle without opening it.
	/**
	* This constructor creates a handle without opening it.
	*
	* @param io_context The io_context object that the handle will use to
	* dispatch handlers for any asynchronous operations performed on the handle.
	*/
	explicit basic_handle(asio::io_context& io_context)
	: basic_io_object<HandleService>(io_context)
	{
	}

	/// Construct a basic_handle on an existing native handle.
	/**
	* This constructor creates a handle object to hold an existing native handle.
	*
	* @param io_context The io_context object that the handle will use to
	* dispatch handlers for any asynchronous operations performed on the handle.
	*
	* @param handle A native handle.
	*
	* @throws asio::system_error Thrown on failure.
	*/
	basic_handle(asio::io_context& io_context,
	const native_handle_type& handle)
	: basic_io_object<HandleService>(io_context)
	{
	asio::error_code ec;
	this->get_service().assign(this->get_implementation(), handle, ec);
	asio::detail::throw_error(ec, "assign");
	}

	#if defined(ASIO_HAS_MOVE) \|\| defined(GENERATING_DOCUMENTATION)
	/// Move-construct a basic_handle from another.
	/**
	* This constructor moves a handle from one object to another.
	*
	* @param other The other basic_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_handle(io_context&) constructor.
	*/
	basic_handle(basic_handle&& other)
	: basic_io_object<HandleService>(
	ASIO_MOVE_CAST(basic_handle)(other))
	{
	}

	/// Move-assign a basic_handle from another.
	/**
	* This assignment operator moves a handle from one object to another.
	*
	* @param other The other basic_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_handle(io_context&) constructor.
	*/
	basic_handle& operator=(basic_handle&& other)
	{
	basic_io_object<HandleService>::operator=(
	ASIO_MOVE_CAST(basic_handle)(other));
	return *this;
	}
	#endif // defined(ASIO_HAS_MOVE) \|\| defined(GENERATING_DOCUMENTATION)

	/// Get a reference to the lowest layer.
	/**
	* This function returns a reference to the lowest layer in a stack of
	* layers. Since a basic_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 a basic_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;
	this->get_service().assign(this->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)
	{
	this->get_service().assign(this->get_implementation(), handle, ec);
	ASIO_SYNC_OP_VOID_RETURN(ec);
	}

	/// Determine whether the handle is open.
	bool is_open() const
	{
	return this->get_service().is_open(this->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;
	this->get_service().close(this->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)
	{
	this->get_service().close(this->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 this->get_service().native_handle(this->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;
	this->get_service().cancel(this->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)
	{
	this->get_service().cancel(this->get_implementation(), ec);
	ASIO_SYNC_OP_VOID_RETURN(ec);
	}

	protected:
	/// Protected destructor to prevent deletion through this type.
	~basic_handle()
	{
	}
	};

	} // 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(ASIO_HAS_WINDOWS_OBJECT_HANDLE)
	// \|\| defined(GENERATING_DOCUMENTATION)

	#endif // defined(ASIO_ENABLE_OLD_SERVICES)

	#endif // ASIO_WINDOWS_BASIC_HANDLE_HPP