1388 lines
		
	
	
		
			52 KiB
		
	
	
	
		
			C++
		
	
	
	
		
		
			
		
	
	
			1388 lines
		
	
	
		
			52 KiB
		
	
	
	
		
			C++
		
	
	
	
|  | //
 | ||
|  | // basic_raw_socket.hpp
 | ||
|  | // ~~~~~~~~~~~~~~~~~~~~
 | ||
|  | //
 | ||
|  | // Copyright (c) 2003-2023 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_BASIC_RAW_SOCKET_HPP
 | ||
|  | #define ASIO_BASIC_RAW_SOCKET_HPP
 | ||
|  | 
 | ||
|  | #if defined(_MSC_VER) && (_MSC_VER >= 1200)
 | ||
|  | # pragma once
 | ||
|  | #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
 | ||
|  | 
 | ||
|  | #include "asio/detail/config.hpp"
 | ||
|  | #include <cstddef>
 | ||
|  | #include "asio/basic_socket.hpp"
 | ||
|  | #include "asio/detail/handler_type_requirements.hpp"
 | ||
|  | #include "asio/detail/non_const_lvalue.hpp"
 | ||
|  | #include "asio/detail/throw_error.hpp"
 | ||
|  | #include "asio/detail/type_traits.hpp"
 | ||
|  | #include "asio/error.hpp"
 | ||
|  | 
 | ||
|  | #include "asio/detail/push_options.hpp"
 | ||
|  | 
 | ||
|  | namespace asio { | ||
|  | 
 | ||
|  | #if !defined(ASIO_BASIC_RAW_SOCKET_FWD_DECL)
 | ||
|  | #define ASIO_BASIC_RAW_SOCKET_FWD_DECL
 | ||
|  | 
 | ||
|  | // Forward declaration with defaulted arguments.
 | ||
|  | template <typename Protocol, typename Executor = any_io_executor> | ||
|  | class basic_raw_socket; | ||
|  | 
 | ||
|  | #endif // !defined(ASIO_BASIC_RAW_SOCKET_FWD_DECL)
 | ||
|  | 
 | ||
|  | /// Provides raw-oriented socket functionality.
 | ||
|  | /**
 | ||
|  |  * The basic_raw_socket class template provides asynchronous and blocking | ||
|  |  * raw-oriented socket functionality. | ||
|  |  * | ||
|  |  * @par Thread Safety | ||
|  |  * @e Distinct @e objects: Safe.@n | ||
|  |  * @e Shared @e objects: Unsafe. | ||
|  |  * | ||
|  |  * Synchronous @c send, @c send_to, @c receive, @c receive_from, @c connect, | ||
|  |  * and @c shutdown operations are thread safe with respect to each other, if | ||
|  |  * the underlying operating system calls are also thread safe. This means that | ||
|  |  * it is permitted to perform concurrent calls to these synchronous operations | ||
|  |  * on a single socket object. Other synchronous operations, such as @c open or | ||
|  |  * @c close, are not thread safe. | ||
|  |  */ | ||
|  | template <typename Protocol, typename Executor> | ||
|  | class basic_raw_socket | ||
|  |   : public basic_socket<Protocol, Executor> | ||
|  | { | ||
|  | private: | ||
|  |   class initiate_async_send; | ||
|  |   class initiate_async_send_to; | ||
|  |   class initiate_async_receive; | ||
|  |   class initiate_async_receive_from; | ||
|  | 
 | ||
|  | public: | ||
|  |   /// The type of the executor associated with the object.
 | ||
|  |   typedef Executor executor_type; | ||
|  | 
 | ||
|  |   /// Rebinds the socket type to another executor.
 | ||
|  |   template <typename Executor1> | ||
|  |   struct rebind_executor | ||
|  |   { | ||
|  |     /// The socket type when rebound to the specified executor.
 | ||
|  |     typedef basic_raw_socket<Protocol, Executor1> other; | ||
|  |   }; | ||
|  | 
 | ||
|  |   /// The native representation of a socket.
 | ||
|  | #if defined(GENERATING_DOCUMENTATION)
 | ||
|  |   typedef implementation_defined native_handle_type; | ||
|  | #else
 | ||
|  |   typedef typename basic_socket<Protocol, | ||
|  |     Executor>::native_handle_type native_handle_type; | ||
|  | #endif
 | ||
|  | 
 | ||
|  |   /// The protocol type.
 | ||
|  |   typedef Protocol protocol_type; | ||
|  | 
 | ||
|  |   /// The endpoint type.
 | ||
|  |   typedef typename Protocol::endpoint endpoint_type; | ||
|  | 
 | ||
|  |   /// Construct a basic_raw_socket without opening it.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates a raw socket without opening it. The open() | ||
|  |    * function must be called before data can be sent or received on the socket. | ||
|  |    * | ||
|  |    * @param ex The I/O executor that the socket will use, by default, to | ||
|  |    * dispatch handlers for any asynchronous operations performed on the socket. | ||
|  |    */ | ||
|  |   explicit basic_raw_socket(const executor_type& ex) | ||
|  |     : basic_socket<Protocol, Executor>(ex) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Construct a basic_raw_socket without opening it.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates a raw socket without opening it. The open() | ||
|  |    * function must be called before data can be sent or received on the socket. | ||
|  |    * | ||
|  |    * @param context An execution context which provides the I/O executor that | ||
|  |    * the socket will use, by default, to dispatch handlers for any asynchronous | ||
|  |    * operations performed on the socket. | ||
|  |    */ | ||
|  |   template <typename ExecutionContext> | ||
|  |   explicit basic_raw_socket(ExecutionContext& context, | ||
|  |       typename constraint< | ||
|  |         is_convertible<ExecutionContext&, execution_context&>::value | ||
|  |       >::type = 0) | ||
|  |     : basic_socket<Protocol, Executor>(context) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Construct and open a basic_raw_socket.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates and opens a raw socket. | ||
|  |    * | ||
|  |    * @param ex The I/O executor that the socket will use, by default, to | ||
|  |    * dispatch handlers for any asynchronous operations performed on the socket. | ||
|  |    * | ||
|  |    * @param protocol An object specifying protocol parameters to be used. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   basic_raw_socket(const executor_type& ex, const protocol_type& protocol) | ||
|  |     : basic_socket<Protocol, Executor>(ex, protocol) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Construct and open a basic_raw_socket.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates and opens a raw socket. | ||
|  |    * | ||
|  |    * @param context An execution context which provides the I/O executor that | ||
|  |    * the socket will use, by default, to dispatch handlers for any asynchronous | ||
|  |    * operations performed on the socket. | ||
|  |    * | ||
|  |    * @param protocol An object specifying protocol parameters to be used. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   template <typename ExecutionContext> | ||
|  |   basic_raw_socket(ExecutionContext& context, const protocol_type& protocol, | ||
|  |       typename constraint< | ||
|  |         is_convertible<ExecutionContext&, execution_context&>::value, | ||
|  |         defaulted_constraint | ||
|  |       >::type = defaulted_constraint()) | ||
|  |     : basic_socket<Protocol, Executor>(context, protocol) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Construct a basic_raw_socket, opening it and binding it to the given
 | ||
|  |   /// local endpoint.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates a raw socket and automatically opens it bound | ||
|  |    * to the specified endpoint on the local machine. The protocol used is the | ||
|  |    * protocol associated with the given endpoint. | ||
|  |    * | ||
|  |    * @param ex The I/O executor that the socket will use, by default, to | ||
|  |    * dispatch handlers for any asynchronous operations performed on the socket. | ||
|  |    * | ||
|  |    * @param endpoint An endpoint on the local machine to which the raw | ||
|  |    * socket will be bound. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   basic_raw_socket(const executor_type& ex, const endpoint_type& endpoint) | ||
|  |     : basic_socket<Protocol, Executor>(ex, endpoint) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Construct a basic_raw_socket, opening it and binding it to the given
 | ||
|  |   /// local endpoint.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates a raw socket and automatically opens it bound | ||
|  |    * to the specified endpoint on the local machine. The protocol used is the | ||
|  |    * protocol associated with the given endpoint. | ||
|  |    * | ||
|  |    * @param context An execution context which provides the I/O executor that | ||
|  |    * the socket will use, by default, to dispatch handlers for any asynchronous | ||
|  |    * operations performed on the socket. | ||
|  |    * | ||
|  |    * @param endpoint An endpoint on the local machine to which the raw | ||
|  |    * socket will be bound. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   template <typename ExecutionContext> | ||
|  |   basic_raw_socket(ExecutionContext& context, const endpoint_type& endpoint, | ||
|  |       typename constraint< | ||
|  |         is_convertible<ExecutionContext&, execution_context&>::value | ||
|  |       >::type = 0) | ||
|  |     : basic_socket<Protocol, Executor>(context, endpoint) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Construct a basic_raw_socket on an existing native socket.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates a raw socket object to hold an existing | ||
|  |    * native socket. | ||
|  |    * | ||
|  |    * @param ex The I/O executor that the socket will use, by default, to | ||
|  |    * dispatch handlers for any asynchronous operations performed on the socket. | ||
|  |    * | ||
|  |    * @param protocol An object specifying protocol parameters to be used. | ||
|  |    * | ||
|  |    * @param native_socket The new underlying socket implementation. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   basic_raw_socket(const executor_type& ex, | ||
|  |       const protocol_type& protocol, const native_handle_type& native_socket) | ||
|  |     : basic_socket<Protocol, Executor>(ex, protocol, native_socket) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Construct a basic_raw_socket on an existing native socket.
 | ||
|  |   /**
 | ||
|  |    * This constructor creates a raw socket object to hold an existing | ||
|  |    * native socket. | ||
|  |    * | ||
|  |    * @param context An execution context which provides the I/O executor that | ||
|  |    * the socket will use, by default, to dispatch handlers for any asynchronous | ||
|  |    * operations performed on the socket. | ||
|  |    * | ||
|  |    * @param protocol An object specifying protocol parameters to be used. | ||
|  |    * | ||
|  |    * @param native_socket The new underlying socket implementation. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   template <typename ExecutionContext> | ||
|  |   basic_raw_socket(ExecutionContext& context, | ||
|  |       const protocol_type& protocol, const native_handle_type& native_socket, | ||
|  |       typename constraint< | ||
|  |         is_convertible<ExecutionContext&, execution_context&>::value | ||
|  |       >::type = 0) | ||
|  |     : basic_socket<Protocol, Executor>(context, protocol, native_socket) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  | #if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
 | ||
|  |   /// Move-construct a basic_raw_socket from another.
 | ||
|  |   /**
 | ||
|  |    * This constructor moves a raw socket from one object to another. | ||
|  |    * | ||
|  |    * @param other The other basic_raw_socket 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_raw_socket(const executor_type&) | ||
|  |    * constructor. | ||
|  |    */ | ||
|  |   basic_raw_socket(basic_raw_socket&& other) ASIO_NOEXCEPT | ||
|  |     : basic_socket<Protocol, Executor>(std::move(other)) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Move-assign a basic_raw_socket from another.
 | ||
|  |   /**
 | ||
|  |    * This assignment operator moves a raw socket from one object to another. | ||
|  |    * | ||
|  |    * @param other The other basic_raw_socket 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_raw_socket(const executor_type&) | ||
|  |    * constructor. | ||
|  |    */ | ||
|  |   basic_raw_socket& operator=(basic_raw_socket&& other) | ||
|  |   { | ||
|  |     basic_socket<Protocol, Executor>::operator=(std::move(other)); | ||
|  |     return *this; | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Move-construct a basic_raw_socket from a socket of another protocol
 | ||
|  |   /// type.
 | ||
|  |   /**
 | ||
|  |    * This constructor moves a raw socket from one object to another. | ||
|  |    * | ||
|  |    * @param other The other basic_raw_socket 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_raw_socket(const executor_type&) | ||
|  |    * constructor. | ||
|  |    */ | ||
|  |   template <typename Protocol1, typename Executor1> | ||
|  |   basic_raw_socket(basic_raw_socket<Protocol1, Executor1>&& other, | ||
|  |       typename constraint< | ||
|  |         is_convertible<Protocol1, Protocol>::value | ||
|  |           && is_convertible<Executor1, Executor>::value | ||
|  |       >::type = 0) | ||
|  |     : basic_socket<Protocol, Executor>(std::move(other)) | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Move-assign a basic_raw_socket from a socket of another protocol type.
 | ||
|  |   /**
 | ||
|  |    * This assignment operator moves a raw socket from one object to another. | ||
|  |    * | ||
|  |    * @param other The other basic_raw_socket 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_raw_socket(const executor_type&) | ||
|  |    * constructor. | ||
|  |    */ | ||
|  |   template <typename Protocol1, typename Executor1> | ||
|  |   typename constraint< | ||
|  |     is_convertible<Protocol1, Protocol>::value | ||
|  |       && is_convertible<Executor1, Executor>::value, | ||
|  |     basic_raw_socket& | ||
|  |   >::type operator=(basic_raw_socket<Protocol1, Executor1>&& other) | ||
|  |   { | ||
|  |     basic_socket<Protocol, Executor>::operator=(std::move(other)); | ||
|  |     return *this; | ||
|  |   } | ||
|  | #endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
 | ||
|  | 
 | ||
|  |   /// Destroys the socket.
 | ||
|  |   /**
 | ||
|  |    * This function destroys the socket, cancelling any outstanding asynchronous | ||
|  |    * operations associated with the socket as if by calling @c cancel. | ||
|  |    */ | ||
|  |   ~basic_raw_socket() | ||
|  |   { | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Send some data on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to send data on the raw socket. The function call | ||
|  |    * will block until the data has been sent successfully or an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One ore more data buffers to be sent on the socket. | ||
|  |    * | ||
|  |    * @returns The number of bytes sent. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    * | ||
|  |    * @note The send operation can only be used with a connected socket. Use | ||
|  |    * the send_to function to send data on an unconnected raw socket. | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To send a single data buffer use the @ref buffer function as follows: | ||
|  |    * @code socket.send(asio::buffer(data, size)); @endcode | ||
|  |    * See the @ref buffer documentation for information on sending multiple | ||
|  |    * buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    */ | ||
|  |   template <typename ConstBufferSequence> | ||
|  |   std::size_t send(const ConstBufferSequence& buffers) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().send( | ||
|  |         this->impl_.get_implementation(), buffers, 0, ec); | ||
|  |     asio::detail::throw_error(ec, "send"); | ||
|  |     return s; | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Send some data on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to send data on the raw socket. The function call | ||
|  |    * will block until the data has been sent successfully or an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One ore more data buffers to be sent on the socket. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the send call is to be made. | ||
|  |    * | ||
|  |    * @returns The number of bytes sent. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    * | ||
|  |    * @note The send operation can only be used with a connected socket. Use | ||
|  |    * the send_to function to send data on an unconnected raw socket. | ||
|  |    */ | ||
|  |   template <typename ConstBufferSequence> | ||
|  |   std::size_t send(const ConstBufferSequence& buffers, | ||
|  |       socket_base::message_flags flags) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().send( | ||
|  |         this->impl_.get_implementation(), buffers, flags, ec); | ||
|  |     asio::detail::throw_error(ec, "send"); | ||
|  |     return s; | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Send some data on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to send data on the raw socket. The function call | ||
|  |    * will block until the data has been sent successfully or an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent on the socket. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the send call is to be made. | ||
|  |    * | ||
|  |    * @param ec Set to indicate what error occurred, if any. | ||
|  |    * | ||
|  |    * @returns The number of bytes sent. | ||
|  |    * | ||
|  |    * @note The send operation can only be used with a connected socket. Use | ||
|  |    * the send_to function to send data on an unconnected raw socket. | ||
|  |    */ | ||
|  |   template <typename ConstBufferSequence> | ||
|  |   std::size_t send(const ConstBufferSequence& buffers, | ||
|  |       socket_base::message_flags flags, asio::error_code& ec) | ||
|  |   { | ||
|  |     return this->impl_.get_service().send( | ||
|  |         this->impl_.get_implementation(), buffers, flags, ec); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous send on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously send data on the raw socket. It is | ||
|  |    * an initiating function for an @ref asynchronous_operation, and always | ||
|  |    * returns immediately. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent on the socket. 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 send 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 sent.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @note The async_send operation can only be used with a connected socket. | ||
|  |    * Use the async_send_to function to send data on an unconnected raw | ||
|  |    * socket. | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To send a single data buffer use the @ref buffer function as follows: | ||
|  |    * @code | ||
|  |    * socket.async_send(asio::buffer(data, size), handler); | ||
|  |    * @endcode | ||
|  |    * See the @ref buffer documentation for information on sending multiple | ||
|  |    * buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(WriteToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_send(const ConstBufferSequence& buffers, | ||
|  |       ASIO_MOVE_ARG(WriteToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<WriteToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_send>(), token, | ||
|  |           buffers, socket_base::message_flags(0)))) | ||
|  |   { | ||
|  |     return async_initiate<WriteToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_send(this), token, | ||
|  |         buffers, socket_base::message_flags(0)); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous send on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously send data on the raw socket. It is | ||
|  |    * an initiating function for an @ref asynchronous_operation, and always | ||
|  |    * returns immediately. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent on the socket. 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 flags Flags specifying how the send call is to be made. | ||
|  |    * | ||
|  |    * @param token The @ref completion_token that will be used to produce a | ||
|  |    * completion handler, which will be called when the send 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 sent.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @note The async_send operation can only be used with a connected socket. | ||
|  |    * Use the async_send_to function to send data on an unconnected raw | ||
|  |    * socket. | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(WriteToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_send(const ConstBufferSequence& buffers, | ||
|  |       socket_base::message_flags flags, | ||
|  |       ASIO_MOVE_ARG(WriteToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<WriteToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_send>(), token, buffers, flags))) | ||
|  |   { | ||
|  |     return async_initiate<WriteToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_send(this), token, buffers, flags); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Send raw data to the specified endpoint.
 | ||
|  |   /**
 | ||
|  |    * This function is used to send raw data to the specified remote endpoint. | ||
|  |    * The function call will block until the data has been sent successfully or | ||
|  |    * an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent to the remote endpoint. | ||
|  |    * | ||
|  |    * @param destination The remote endpoint to which the data will be sent. | ||
|  |    * | ||
|  |    * @returns The number of bytes sent. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To send a single data buffer use the @ref buffer function as follows: | ||
|  |    * @code | ||
|  |    * asio::ip::udp::endpoint destination( | ||
|  |    *     asio::ip::address::from_string("1.2.3.4"), 12345); | ||
|  |    * socket.send_to(asio::buffer(data, size), destination); | ||
|  |    * @endcode | ||
|  |    * See the @ref buffer documentation for information on sending multiple | ||
|  |    * buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    */ | ||
|  |   template <typename ConstBufferSequence> | ||
|  |   std::size_t send_to(const ConstBufferSequence& buffers, | ||
|  |       const endpoint_type& destination) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().send_to( | ||
|  |         this->impl_.get_implementation(), buffers, destination, 0, ec); | ||
|  |     asio::detail::throw_error(ec, "send_to"); | ||
|  |     return s; | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Send raw data to the specified endpoint.
 | ||
|  |   /**
 | ||
|  |    * This function is used to send raw data to the specified remote endpoint. | ||
|  |    * The function call will block until the data has been sent successfully or | ||
|  |    * an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent to the remote endpoint. | ||
|  |    * | ||
|  |    * @param destination The remote endpoint to which the data will be sent. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the send call is to be made. | ||
|  |    * | ||
|  |    * @returns The number of bytes sent. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   template <typename ConstBufferSequence> | ||
|  |   std::size_t send_to(const ConstBufferSequence& buffers, | ||
|  |       const endpoint_type& destination, socket_base::message_flags flags) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().send_to( | ||
|  |         this->impl_.get_implementation(), buffers, destination, flags, ec); | ||
|  |     asio::detail::throw_error(ec, "send_to"); | ||
|  |     return s; | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Send raw data to the specified endpoint.
 | ||
|  |   /**
 | ||
|  |    * This function is used to send raw data to the specified remote endpoint. | ||
|  |    * The function call will block until the data has been sent successfully or | ||
|  |    * an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent to the remote endpoint. | ||
|  |    * | ||
|  |    * @param destination The remote endpoint to which the data will be sent. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the send call is to be made. | ||
|  |    * | ||
|  |    * @param ec Set to indicate what error occurred, if any. | ||
|  |    * | ||
|  |    * @returns The number of bytes sent. | ||
|  |    */ | ||
|  |   template <typename ConstBufferSequence> | ||
|  |   std::size_t send_to(const ConstBufferSequence& buffers, | ||
|  |       const endpoint_type& destination, socket_base::message_flags flags, | ||
|  |       asio::error_code& ec) | ||
|  |   { | ||
|  |     return this->impl_.get_service().send_to(this->impl_.get_implementation(), | ||
|  |         buffers, destination, flags, ec); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous send.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously send raw data to the specified | ||
|  |    * remote endpoint. It is an initiating function for an @ref | ||
|  |    * asynchronous_operation, and always returns immediately. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent to the remote endpoint. | ||
|  |    * 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 destination The remote endpoint to which the data will be sent. | ||
|  |    * Copies will be made of the endpoint as required. | ||
|  |    * | ||
|  |    * @param token The @ref completion_token that will be used to produce a | ||
|  |    * completion handler, which will be called when the send 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 sent.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To send a single data buffer use the @ref buffer function as follows: | ||
|  |    * @code | ||
|  |    * asio::ip::udp::endpoint destination( | ||
|  |    *     asio::ip::address::from_string("1.2.3.4"), 12345); | ||
|  |    * socket.async_send_to( | ||
|  |    *     asio::buffer(data, size), destination, handler); | ||
|  |    * @endcode | ||
|  |    * See the @ref buffer documentation for information on sending multiple | ||
|  |    * buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(WriteToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_send_to(const ConstBufferSequence& buffers, | ||
|  |       const endpoint_type& destination, | ||
|  |       ASIO_MOVE_ARG(WriteToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<WriteToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_send_to>(), token, buffers, | ||
|  |           destination, socket_base::message_flags(0)))) | ||
|  |   { | ||
|  |     return async_initiate<WriteToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_send_to(this), token, buffers, | ||
|  |         destination, socket_base::message_flags(0)); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous send.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously send raw data to the specified | ||
|  |    * remote endpoint. It is an initiating function for an @ref | ||
|  |    * asynchronous_operation, and always returns immediately. | ||
|  |    * | ||
|  |    * @param buffers One or more data buffers to be sent to the remote endpoint. | ||
|  |    * 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 flags Flags specifying how the send call is to be made. | ||
|  |    * | ||
|  |    * @param destination The remote endpoint to which the data will be sent. | ||
|  |    * Copies will be made of the endpoint as required. | ||
|  |    * | ||
|  |    * @param token The @ref completion_token that will be used to produce a | ||
|  |    * completion handler, which will be called when the send 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 sent.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(WriteToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_send_to(const ConstBufferSequence& buffers, | ||
|  |       const endpoint_type& destination, socket_base::message_flags flags, | ||
|  |       ASIO_MOVE_ARG(WriteToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<WriteToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_send_to>(), token, | ||
|  |           buffers, destination, flags))) | ||
|  |   { | ||
|  |     return async_initiate<WriteToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_send_to(this), token, | ||
|  |         buffers, destination, flags); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Receive some data on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to receive data on the raw socket. The function | ||
|  |    * call will block until data has been received successfully or an error | ||
|  |    * occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more buffers into which the data will be received. | ||
|  |    * | ||
|  |    * @returns The number of bytes received. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    * | ||
|  |    * @note The receive operation can only be used with a connected socket. Use | ||
|  |    * the receive_from function to receive data on an unconnected raw | ||
|  |    * socket. | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To receive into a single data buffer use the @ref buffer function as | ||
|  |    * follows: | ||
|  |    * @code socket.receive(asio::buffer(data, size)); @endcode | ||
|  |    * See the @ref buffer documentation for information on receiving into | ||
|  |    * multiple buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    */ | ||
|  |   template <typename MutableBufferSequence> | ||
|  |   std::size_t receive(const MutableBufferSequence& buffers) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().receive( | ||
|  |         this->impl_.get_implementation(), buffers, 0, ec); | ||
|  |     asio::detail::throw_error(ec, "receive"); | ||
|  |     return s; | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Receive some data on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to receive data on the raw socket. The function | ||
|  |    * call will block until data has been received successfully or an error | ||
|  |    * occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more buffers into which the data will be received. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the receive call is to be made. | ||
|  |    * | ||
|  |    * @returns The number of bytes received. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    * | ||
|  |    * @note The receive operation can only be used with a connected socket. Use | ||
|  |    * the receive_from function to receive data on an unconnected raw | ||
|  |    * socket. | ||
|  |    */ | ||
|  |   template <typename MutableBufferSequence> | ||
|  |   std::size_t receive(const MutableBufferSequence& buffers, | ||
|  |       socket_base::message_flags flags) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().receive( | ||
|  |         this->impl_.get_implementation(), buffers, flags, ec); | ||
|  |     asio::detail::throw_error(ec, "receive"); | ||
|  |     return s; | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Receive some data on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to receive data on the raw socket. The function | ||
|  |    * call will block until data has been received successfully or an error | ||
|  |    * occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more buffers into which the data will be received. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the receive call is to be made. | ||
|  |    * | ||
|  |    * @param ec Set to indicate what error occurred, if any. | ||
|  |    * | ||
|  |    * @returns The number of bytes received. | ||
|  |    * | ||
|  |    * @note The receive operation can only be used with a connected socket. Use | ||
|  |    * the receive_from function to receive data on an unconnected raw | ||
|  |    * socket. | ||
|  |    */ | ||
|  |   template <typename MutableBufferSequence> | ||
|  |   std::size_t receive(const MutableBufferSequence& buffers, | ||
|  |       socket_base::message_flags flags, asio::error_code& ec) | ||
|  |   { | ||
|  |     return this->impl_.get_service().receive( | ||
|  |         this->impl_.get_implementation(), buffers, flags, ec); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous receive on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously receive data from the raw | ||
|  |    * socket. 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 received. | ||
|  |    * 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 receive 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 received.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @note The async_receive operation can only be used with a connected socket. | ||
|  |    * Use the async_receive_from function to receive data on an unconnected | ||
|  |    * raw socket. | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To receive into a single data buffer use the @ref buffer function as | ||
|  |    * follows: | ||
|  |    * @code | ||
|  |    * socket.async_receive(asio::buffer(data, size), handler); | ||
|  |    * @endcode | ||
|  |    * See the @ref buffer documentation for information on receiving into | ||
|  |    * multiple buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(ReadToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_receive(const MutableBufferSequence& buffers, | ||
|  |       ASIO_MOVE_ARG(ReadToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<ReadToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_receive>(), token, | ||
|  |           buffers, socket_base::message_flags(0)))) | ||
|  |   { | ||
|  |     return async_initiate<ReadToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_receive(this), token, | ||
|  |         buffers, socket_base::message_flags(0)); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous receive on a connected socket.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously receive data from the raw | ||
|  |    * socket. 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 received. | ||
|  |    * 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 flags Flags specifying how the receive call is to be made. | ||
|  |    * | ||
|  |    * @param token The @ref completion_token that will be used to produce a | ||
|  |    * completion handler, which will be called when the receive 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 received.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @note The async_receive operation can only be used with a connected socket. | ||
|  |    * Use the async_receive_from function to receive data on an unconnected | ||
|  |    * raw socket. | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(ReadToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_receive(const MutableBufferSequence& buffers, | ||
|  |       socket_base::message_flags flags, | ||
|  |       ASIO_MOVE_ARG(ReadToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<ReadToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_receive>(), token, buffers, flags))) | ||
|  |   { | ||
|  |     return async_initiate<ReadToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_receive(this), token, buffers, flags); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Receive raw data with the endpoint of the sender.
 | ||
|  |   /**
 | ||
|  |    * This function is used to receive raw data. The function call will block | ||
|  |    * until data has been received successfully or an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more buffers into which the data will be received. | ||
|  |    * | ||
|  |    * @param sender_endpoint An endpoint object that receives the endpoint of | ||
|  |    * the remote sender of the data. | ||
|  |    * | ||
|  |    * @returns The number of bytes received. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To receive into a single data buffer use the @ref buffer function as | ||
|  |    * follows: | ||
|  |    * @code | ||
|  |    * asio::ip::udp::endpoint sender_endpoint; | ||
|  |    * socket.receive_from( | ||
|  |    *     asio::buffer(data, size), sender_endpoint); | ||
|  |    * @endcode | ||
|  |    * See the @ref buffer documentation for information on receiving into | ||
|  |    * multiple buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    */ | ||
|  |   template <typename MutableBufferSequence> | ||
|  |   std::size_t receive_from(const MutableBufferSequence& buffers, | ||
|  |       endpoint_type& sender_endpoint) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().receive_from( | ||
|  |         this->impl_.get_implementation(), buffers, sender_endpoint, 0, ec); | ||
|  |     asio::detail::throw_error(ec, "receive_from"); | ||
|  |     return s; | ||
|  |   } | ||
|  |    | ||
|  |   /// Receive raw data with the endpoint of the sender.
 | ||
|  |   /**
 | ||
|  |    * This function is used to receive raw data. The function call will block | ||
|  |    * until data has been received successfully or an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more buffers into which the data will be received. | ||
|  |    * | ||
|  |    * @param sender_endpoint An endpoint object that receives the endpoint of | ||
|  |    * the remote sender of the data. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the receive call is to be made. | ||
|  |    * | ||
|  |    * @returns The number of bytes received. | ||
|  |    * | ||
|  |    * @throws asio::system_error Thrown on failure. | ||
|  |    */ | ||
|  |   template <typename MutableBufferSequence> | ||
|  |   std::size_t receive_from(const MutableBufferSequence& buffers, | ||
|  |       endpoint_type& sender_endpoint, socket_base::message_flags flags) | ||
|  |   { | ||
|  |     asio::error_code ec; | ||
|  |     std::size_t s = this->impl_.get_service().receive_from( | ||
|  |         this->impl_.get_implementation(), buffers, sender_endpoint, flags, ec); | ||
|  |     asio::detail::throw_error(ec, "receive_from"); | ||
|  |     return s; | ||
|  |   } | ||
|  |    | ||
|  |   /// Receive raw data with the endpoint of the sender.
 | ||
|  |   /**
 | ||
|  |    * This function is used to receive raw data. The function call will block | ||
|  |    * until data has been received successfully or an error occurs. | ||
|  |    * | ||
|  |    * @param buffers One or more buffers into which the data will be received. | ||
|  |    * | ||
|  |    * @param sender_endpoint An endpoint object that receives the endpoint of | ||
|  |    * the remote sender of the data. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the receive call is to be made. | ||
|  |    * | ||
|  |    * @param ec Set to indicate what error occurred, if any. | ||
|  |    * | ||
|  |    * @returns The number of bytes received. | ||
|  |    */ | ||
|  |   template <typename MutableBufferSequence> | ||
|  |   std::size_t receive_from(const MutableBufferSequence& buffers, | ||
|  |       endpoint_type& sender_endpoint, socket_base::message_flags flags, | ||
|  |       asio::error_code& ec) | ||
|  |   { | ||
|  |     return this->impl_.get_service().receive_from( | ||
|  |         this->impl_.get_implementation(), buffers, sender_endpoint, flags, ec); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous receive.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously receive raw data. 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 received. | ||
|  |    * 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 sender_endpoint An endpoint object that receives the endpoint of | ||
|  |    * the remote sender of the data. Ownership of the sender_endpoint object | ||
|  |    * is retained by the caller, which must guarantee that it is 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 receive 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 received.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @par Example | ||
|  |    * To receive into a single data buffer use the @ref buffer function as | ||
|  |    * follows: | ||
|  |    * @code socket.async_receive_from( | ||
|  |    *     asio::buffer(data, size), 0, sender_endpoint, handler); @endcode | ||
|  |    * See the @ref buffer documentation for information on receiving into | ||
|  |    * multiple buffers in one go, and how to use it with arrays, boost::array or | ||
|  |    * std::vector. | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(ReadToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_receive_from(const MutableBufferSequence& buffers, | ||
|  |       endpoint_type& sender_endpoint, | ||
|  |       ASIO_MOVE_ARG(ReadToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<ReadToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_receive_from>(), token, buffers, | ||
|  |           &sender_endpoint, socket_base::message_flags(0)))) | ||
|  |   { | ||
|  |     return async_initiate<ReadToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_receive_from(this), token, buffers, | ||
|  |         &sender_endpoint, socket_base::message_flags(0)); | ||
|  |   } | ||
|  | 
 | ||
|  |   /// Start an asynchronous receive.
 | ||
|  |   /**
 | ||
|  |    * This function is used to asynchronously receive raw data. 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 received. | ||
|  |    * 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 sender_endpoint An endpoint object that receives the endpoint of | ||
|  |    * the remote sender of the data. Ownership of the sender_endpoint object | ||
|  |    * is retained by the caller, which must guarantee that it is valid until the | ||
|  |    * completion handler is called. | ||
|  |    * | ||
|  |    * @param flags Flags specifying how the receive call is to be made. | ||
|  |    * | ||
|  |    * @param token The @ref completion_token that will be used to produce a | ||
|  |    * completion handler, which will be called when the receive 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 received.
 | ||
|  |    * ); @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::post(). | ||
|  |    * | ||
|  |    * @par Completion Signature | ||
|  |    * @code void(asio::error_code, std::size_t) @endcode | ||
|  |    * | ||
|  |    * @par Per-Operation Cancellation | ||
|  |    * On POSIX or Windows operating systems, 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 | ||
|  |           ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)> | ||
|  |   ASIO_INITFN_AUTO_RESULT_TYPE_PREFIX(ReadToken, | ||
|  |       void (asio::error_code, std::size_t)) | ||
|  |   async_receive_from(const MutableBufferSequence& buffers, | ||
|  |       endpoint_type& sender_endpoint, socket_base::message_flags flags, | ||
|  |       ASIO_MOVE_ARG(ReadToken) token | ||
|  |         ASIO_DEFAULT_COMPLETION_TOKEN(executor_type)) | ||
|  |     ASIO_INITFN_AUTO_RESULT_TYPE_SUFFIX(( | ||
|  |       async_initiate<ReadToken, | ||
|  |         void (asio::error_code, std::size_t)>( | ||
|  |           declval<initiate_async_receive_from>(), token, | ||
|  |           buffers, &sender_endpoint, flags))) | ||
|  |   { | ||
|  |     return async_initiate<ReadToken, | ||
|  |       void (asio::error_code, std::size_t)>( | ||
|  |         initiate_async_receive_from(this), token, | ||
|  |         buffers, &sender_endpoint, flags); | ||
|  |   } | ||
|  | 
 | ||
|  | private: | ||
|  |   // Disallow copying and assignment.
 | ||
|  |   basic_raw_socket(const basic_raw_socket&) ASIO_DELETED; | ||
|  |   basic_raw_socket& operator=(const basic_raw_socket&) ASIO_DELETED; | ||
|  | 
 | ||
|  |   class initiate_async_send | ||
|  |   { | ||
|  |   public: | ||
|  |     typedef Executor executor_type; | ||
|  | 
 | ||
|  |     explicit initiate_async_send(basic_raw_socket* self) | ||
|  |       : self_(self) | ||
|  |     { | ||
|  |     } | ||
|  | 
 | ||
|  |     const executor_type& get_executor() const ASIO_NOEXCEPT | ||
|  |     { | ||
|  |       return self_->get_executor(); | ||
|  |     } | ||
|  | 
 | ||
|  |     template <typename WriteHandler, typename ConstBufferSequence> | ||
|  |     void operator()(ASIO_MOVE_ARG(WriteHandler) handler, | ||
|  |         const ConstBufferSequence& buffers, | ||
|  |         socket_base::message_flags flags) 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_send( | ||
|  |           self_->impl_.get_implementation(), buffers, flags, | ||
|  |           handler2.value, self_->impl_.get_executor()); | ||
|  |     } | ||
|  | 
 | ||
|  |   private: | ||
|  |     basic_raw_socket* self_; | ||
|  |   }; | ||
|  | 
 | ||
|  |   class initiate_async_send_to | ||
|  |   { | ||
|  |   public: | ||
|  |     typedef Executor executor_type; | ||
|  | 
 | ||
|  |     explicit initiate_async_send_to(basic_raw_socket* self) | ||
|  |       : self_(self) | ||
|  |     { | ||
|  |     } | ||
|  | 
 | ||
|  |     const executor_type& get_executor() const ASIO_NOEXCEPT | ||
|  |     { | ||
|  |       return self_->get_executor(); | ||
|  |     } | ||
|  | 
 | ||
|  |     template <typename WriteHandler, typename ConstBufferSequence> | ||
|  |     void operator()(ASIO_MOVE_ARG(WriteHandler) handler, | ||
|  |         const ConstBufferSequence& buffers, const endpoint_type& destination, | ||
|  |         socket_base::message_flags flags) 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_send_to( | ||
|  |           self_->impl_.get_implementation(), buffers, destination, | ||
|  |           flags, handler2.value, self_->impl_.get_executor()); | ||
|  |     } | ||
|  | 
 | ||
|  |   private: | ||
|  |     basic_raw_socket* self_; | ||
|  |   }; | ||
|  | 
 | ||
|  |   class initiate_async_receive | ||
|  |   { | ||
|  |   public: | ||
|  |     typedef Executor executor_type; | ||
|  | 
 | ||
|  |     explicit initiate_async_receive(basic_raw_socket* self) | ||
|  |       : self_(self) | ||
|  |     { | ||
|  |     } | ||
|  | 
 | ||
|  |     const executor_type& get_executor() const ASIO_NOEXCEPT | ||
|  |     { | ||
|  |       return self_->get_executor(); | ||
|  |     } | ||
|  | 
 | ||
|  |     template <typename ReadHandler, typename MutableBufferSequence> | ||
|  |     void operator()(ASIO_MOVE_ARG(ReadHandler) handler, | ||
|  |         const MutableBufferSequence& buffers, | ||
|  |         socket_base::message_flags flags) 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_receive( | ||
|  |           self_->impl_.get_implementation(), buffers, flags, | ||
|  |           handler2.value, self_->impl_.get_executor()); | ||
|  |     } | ||
|  | 
 | ||
|  |   private: | ||
|  |     basic_raw_socket* self_; | ||
|  |   }; | ||
|  | 
 | ||
|  |   class initiate_async_receive_from | ||
|  |   { | ||
|  |   public: | ||
|  |     typedef Executor executor_type; | ||
|  | 
 | ||
|  |     explicit initiate_async_receive_from(basic_raw_socket* self) | ||
|  |       : self_(self) | ||
|  |     { | ||
|  |     } | ||
|  | 
 | ||
|  |     const executor_type& get_executor() const ASIO_NOEXCEPT | ||
|  |     { | ||
|  |       return self_->get_executor(); | ||
|  |     } | ||
|  | 
 | ||
|  |     template <typename ReadHandler, typename MutableBufferSequence> | ||
|  |     void operator()(ASIO_MOVE_ARG(ReadHandler) handler, | ||
|  |         const MutableBufferSequence& buffers, endpoint_type* sender_endpoint, | ||
|  |         socket_base::message_flags flags) 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_receive_from( | ||
|  |           self_->impl_.get_implementation(), buffers, *sender_endpoint, | ||
|  |           flags, handler2.value, self_->impl_.get_executor()); | ||
|  |     } | ||
|  | 
 | ||
|  |   private: | ||
|  |     basic_raw_socket* self_; | ||
|  |   }; | ||
|  | }; | ||
|  | 
 | ||
|  | } // namespace asio
 | ||
|  | 
 | ||
|  | #include "asio/detail/pop_options.hpp"
 | ||
|  | 
 | ||
|  | #endif // ASIO_BASIC_RAW_SOCKET_HPP
 |