Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator > Class Template Reference

#include <asio_async_ops.h>

Inheritance diagram for Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >:

Public Types
using	allocator_type = boost::asio::associated_allocator_t< Handler, Allocator >
using	executor_type = boost::asio::associated_executor_t< Handler, Executor1 >

Public Member Functions
	AsyncHandshakeOperation (AsyncHandshakeOperation &&)=default
template<class HandlerT >
	AsyncHandshakeOperation (HandlerT &&handler, Stream &stream, const boost::system::error_code &ec={})
allocator_type	get_allocator () const noexcept
executor_type	get_executor () const noexcept
void	operator() (boost::system::error_code ec, std::size_t bytesTransferred, bool isContinuation=true)

Protected Member Functions
template<class... Args>
void	complete_now (Args &&... args)

Protected Attributes
Handler	m_handler
boost::asio::executor_work_guard< Executor1 >	m_work_guard_1

Detailed Description

template<class Handler, class Stream, class Allocator = std::allocator<void>>
class Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >

Definition at line 236 of file asio_async_ops.h.

Member Typedef Documentation

allocator_type

template<class Handler , class Executor1 , class Allocator >

using Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::allocator_type = boost::asio::associated_allocator_t<Handler, Allocator>

inherited

Definition at line 68 of file asio_async_ops.h.

executor_type

template<class Handler , class Executor1 , class Allocator >

using Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::executor_type = boost::asio::associated_executor_t<Handler, Executor1>

inherited

Definition at line 69 of file asio_async_ops.h.

Constructor & Destructor Documentation

AsyncHandshakeOperation() [1/2]

template<class Handler , class Stream , class Allocator = std::allocator<void>>

template<class HandlerT >

Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::AsyncHandshakeOperation ( HandlerT &&  handler, Stream &  stream, const boost::system::error_code &  ec = {}  )

inline

Construct and invoke an AsyncHandshakeOperation.

Parameters

handler	Handler function to be called upon completion.
stream	The stream from which the data will be read
ec	Optional error code; used to report an error to the handler function.

Definition at line 246 of file asio_async_ops.h.

                                                                                                    {}) :
            AsyncBase<Handler, typename Stream::executor_type, Allocator>(std::forward<HandlerT>(handler),
                                                                          stream.get_executor()),
            m_stream(stream) {
         this->operator()(ec, std::size_t(0), false);
      }

AsyncHandshakeOperation() [2/2]

template<class Handler , class Stream , class Allocator = std::allocator<void>>

Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::AsyncHandshakeOperation ( AsyncHandshakeOperation< Handler, Stream, Allocator > &&  )

default

Member Function Documentation

complete_now()

template<class Handler , class Executor1 , class Allocator >

template<class... Args>

void Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::complete_now ( Args &&...  args )

inlineprotectedinherited

Call the completion handler.

This function should only be called after an intermediate initiating function has been called.

Parameters

args	Arguments forwarded to the completion handler function.

Definition at line 90 of file asio_async_ops.h.

                                        {
         m_work_guard_1.reset();
         m_handler(std::forward<Args>(args)...);
      }

References Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::m_handler, and Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::m_work_guard_1.

Referenced by Botan::TLS::detail::AsyncReadOperation< Handler, Stream, MutableBufferSequence, Allocator >::operator()(), Botan::TLS::detail::AsyncWriteOperation< Handler, Stream, Allocator >::operator()(), and Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::operator()().

get_allocator()

template<class Handler , class Executor1 , class Allocator >

allocator_type Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::get_allocator ( ) const

inlinenoexceptinherited

Definition at line 71 of file asio_async_ops.h.

{ return boost::asio::get_associated_allocator(m_handler); }

References Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::m_handler.

get_executor()

template<class Handler , class Executor1 , class Allocator >

executor_type Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::get_executor ( ) const

inlinenoexceptinherited

Definition at line 73 of file asio_async_ops.h.

                                                  {
         return boost::asio::get_associated_executor(m_handler, m_work_guard_1.get_executor());
      }

References Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::m_handler, and Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::m_work_guard_1.

operator()()

template<class Handler , class Stream , class Allocator = std::allocator<void>>

void Botan::TLS::detail::AsyncHandshakeOperation< Handler, Stream, Allocator >::operator() ( boost::system::error_code  ec, std::size_t  bytesTransferred, bool  isContinuation = true  )

inline

Definition at line 255 of file asio_async_ops.h.

                                                                                                        {
         reenter(this) {
            if(ec == boost::asio::error::eof) {
               ec = StreamError::StreamTruncated;
            }
 
            if(bytesTransferred > 0 && !ec) {
               // Provide encrypted TLS data received from the network to TLS::Channel for decryption
               boost::asio::const_buffer read_buffer{m_stream.input_buffer().data(), bytesTransferred};
               m_stream.process_encrypted_data(read_buffer, ec);
            }
 
            if(m_stream.has_data_to_send() && !ec) {
               // Write encrypted TLS data provided by the TLS::Channel on the wire
 
               // Note: we construct `AsyncWriteOperation` with 0 as its last parameter (`plainBytesTransferred`). This
               // operation will eventually call `*this` as its own handler, passing the 0 back to this call operator.
               // This is necessary because the check of `bytesTransferred > 0` assumes that `bytesTransferred` bytes
               // were just read and are available in input_buffer for further processing.
               AsyncWriteOperation<AsyncHandshakeOperation<typename std::decay<Handler>::type, Stream, Allocator>,
                                   Stream,
                                   Allocator>
                  op{std::move(*this), m_stream, 0};
               return;
            }
 
            if(!m_stream.native_handle()->is_active() && !ec) {
               // Read more encrypted TLS data from the network
               m_stream.next_layer().async_read_some(m_stream.input_buffer(), std::move(*this));
               return;
            }
 
            if(!isContinuation) {
               // Make sure the handler is not called without an intermediate initiating function.
               // "Reading" into a zero-byte buffer will complete immediately.
               m_ec = ec;
               yield m_stream.next_layer().async_read_some(boost::asio::mutable_buffer(), std::move(*this));
               ec = m_ec;
            }
 
            this->complete_now(ec);
         }
      }

References Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::complete_now(), Botan::TLS::Stream< StreamLayer, ChannelT >::has_data_to_send(), Botan::TLS::Stream< StreamLayer, ChannelT >::input_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::native_handle(), Botan::TLS::Stream< StreamLayer, ChannelT >::next_layer(), Botan::TLS::Stream< StreamLayer, ChannelT >::process_encrypted_data(), and Botan::TLS::StreamTruncated.

Member Data Documentation

m_handler

template<class Handler , class Executor1 , class Allocator >

Handler Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::m_handler

protectedinherited

Definition at line 95 of file asio_async_ops.h.

Referenced by Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::complete_now(), Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::get_allocator(), and Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::get_executor().

m_work_guard_1

template<class Handler , class Executor1 , class Allocator >

boost::asio::executor_work_guard<Executor1> Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::m_work_guard_1

protectedinherited

Definition at line 96 of file asio_async_ops.h.

Referenced by Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::complete_now(), and Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::get_executor().

---

The documentation for this class was generated from the following file:

• src/lib/tls/asio/asio_async_ops.h