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

#include <asio_async_ops.h>

Inheritance diagram for Botan::TLS::detail::AsyncWriteOperation< 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
	AsyncWriteOperation (AsyncWriteOperation &&)=default
template<class HandlerT >
	AsyncWriteOperation (HandlerT &&handler, Stream &stream, std::size_t plainBytesTransferred, 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 bytes_transferred, 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<typename Handler, class Stream, class Allocator = std::allocator<void>>
class Botan::TLS::detail::AsyncWriteOperation< Handler, Stream, Allocator >

Definition at line 195 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 71 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 72 of file asio_async_ops.h.

Constructor & Destructor Documentation

AsyncWriteOperation() [1/2]

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

template<class HandlerT >

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

inline

Construct and invoke an AsyncWriteOperation.

Parameters

handler	Handler function to be called upon completion.
stream	The stream from which the data will be read
plainBytesTransferred	Number of bytes to be reported to the user-provided handler function as bytes_transferred. This needs to be provided since the amount of plaintext data consumed from the input buffer can differ from the amount of encrypted data written to the next layer.
ec	Optional error code; used to report an error to the handler function.

Definition at line 210 of file asio_async_ops.h.

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

AsyncWriteOperation() [2/2]

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

Botan::TLS::detail::AsyncWriteOperation< Handler, Stream, Allocator >::AsyncWriteOperation ( AsyncWriteOperation< 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 100 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 74 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 79 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<typename Handler , class Stream , class Allocator = std::allocator<void>>

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

inline

Definition at line 225 of file asio_async_ops.h.

         {
         reenter(this)
            {
            // mark the number of encrypted bytes sent to the network as "consumed"
            // Note: bytes_transferred will be zero on first call
            m_stream.consume_send_buffer(bytes_transferred);
 
            if(m_stream.has_data_to_send() && !ec)
               {
               m_stream.next_layer().async_write_some(m_stream.send_buffer(), std::move(*this));
               return;
               }
 
            if (ec == boost::asio::error::eof && !m_stream.shutdown_received())
               {
               // transport layer was closed by peer without receiving 'close_notify'
               ec = StreamError::StreamTruncated;
               }
 
            if(!isContinuation)
               {
               // Make sure the handler is not called without an intermediate initiating function.
               // "Writing" to a zero-byte buffer will complete immediately.
               m_ec = ec;
               yield m_stream.next_layer().async_write_some(boost::asio::const_buffer(), std::move(*this));
               ec = m_ec;
               }
 
            // The size of the sent TLS record can differ from the size of the payload due to TLS encryption. We need to
            // tell the handler how many bytes of the original data we already processed.
            this->complete_now(ec, m_plainBytesTransferred);
            }
         }

References Botan::TLS::detail::AsyncBase< Handler, Executor1, Allocator >::complete_now(), Botan::TLS::Stream< StreamLayer, ChannelT >::consume_send_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::has_data_to_send(), Botan::TLS::Stream< StreamLayer, ChannelT >::next_layer(), Botan::TLS::Stream< StreamLayer, ChannelT >::send_buffer(), Botan::TLS::Stream< StreamLayer, ChannelT >::shutdown_received(), 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 106 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 107 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