stdex
Additional custom or not Standard C++ covered algorithms
Loading...
Searching...
No Matches
stdex::stream::async_writer< N_cap > Class Template Reference

Provides write-back stream capability. More...

#include <stdex/stream.hpp>

Inheritance diagram for stdex::stream::async_writer< N_cap >:
stdex::stream::converter stdex::stream::basic

Public Member Functions

 async_writer (basic &source)
 
virtual size_t write (_In_reads_bytes_opt_(length) const void *data, size_t length)
 Writes block of data to the stream.
 
virtual void flush ()
 Persists volatile element data.
 
- Public Member Functions inherited from stdex::stream::converter
 converter (basic &source)
 
virtual size_t read (_Out_writes_bytes_to_opt_(length, return) void *data, size_t length)
 Reads block of data from the stream.
 
virtual void close ()
 Closes the stream.
 
- Public Member Functions inherited from stdex::stream::basic
 basic (state_t state=state_t::ok)
 
virtual void skip (fsize_t amount)
 Skips given amount of bytes of data on the stream.
 
state_t state () const
 Returns stream state after last operation.
 
bool ok () const
 Returns true if the stream state is clean i.e. previous operation was successful.
 
virtual std::vector< uint8_t > read_remainder (size_t max_length=SIZE_MAX)
 Reads and returns remainder of the stream.
 
uint8_t read_byte ()
 Reads one byte of data.
 
void write_byte (uint8_t byte, fsize_t amount=1)
 Writes a byte of data.
 
template<class T >
basicread_data (T &data)
 Reads one primitive data type.
 
template<class T >
basicwrite_data (const T data)
 Writes one primitive data type.
 
template<class T , class TR = std::char_traits<T>, class AX = std::allocator<T>>
size_t readln (std::basic_string< T, TR, AX > &str)
 Reads stream to the end-of-line or end-of-file.
 
template<class T_from , class T_to , class TR = std::char_traits<T_to>, class AX = std::allocator<T_to>>
size_t readln (std::basic_string< T_to, TR, AX > &str, charset_encoder< T_from, T_to > &encoder)
 Reads stream to the end-of-line or end-of-file.
 
template<class T , class TR = std::char_traits<T>, class AX = std::allocator<T>>
size_t readln_and_attach (std::basic_string< T, TR, AX > &str)
 Reads stream to the end-of-line or end-of-file and append to str.
 
template<class T_from , class T_to , class TR = std::char_traits<T_to>, class AX = std::allocator<T_to>>
size_t readln_and_attach (std::basic_string< T_to, TR, AX > &str, charset_encoder< T_from, T_to > &encoder)
 Reads stream to the end-of-line or end-of-file and append to str.
 
size_t read_array (_Out_writes_bytes_(size *count) void *array, size_t size, size_t count)
 Reads an array of data from the stream.
 
size_t write_array (_In_reads_bytes_opt_(size *count) const void *array, size_t size, size_t count)
 Writes an array of data to the stream.
 
template<class T_from , class T_to >
size_t write_array (const T_from *str, charset_encoder< T_from, T_to > &encoder)
 Writes array of characters to the stream.
 
template<class T_from , class T_to >
size_t write_array (_In_reads_or_z_opt_(num_chars) const T_from *str, size_t num_chars, charset_encoder< T_from, T_to > &encoder)
 Writes array of characters to the stream.
 
template<class T_from , class T_to , class TR = std::char_traits<T_from>, class AX = std::allocator<T_from>>
size_t write_array (const std::basic_string< T_from, TR, AX > &str, charset_encoder< T_from, T_to > &encoder)
 Writes array of characters to the stream.
 
template<class T , class TR = std::char_traits<T>, class AX = std::allocator<T>>
basicread_str (std::basic_string< T, TR, AX > &data)
 Reads length-prefixed string from the stream.
 
template<class T >
basicwrite_str (const T *data)
 Writes string to the stream length-prefixed.
 
template<class T , class TR = std::char_traits<T>, class AX = std::allocator<T>>
basicwrite_str (const std::basic_string< T, TR, AX > &data)
 Writes string to the stream length-prefixed.
 
fsize_t write_stream (basic &stream, fsize_t amount=fsize_max)
 Writes content of another stream.
 
void write_charset (charset_id charset)
 Writes UTF8, UTF-16 or UTF-32 byte-order-mark.
 
size_t write_sprintf (_Printf_format_string_params_(2) const char *format, locale_t locale,...)
 Writes formatted string to the stream.
 
size_t write_sprintf (_Printf_format_string_params_(2) const wchar_t *format, locale_t locale,...)
 Writes formatted string to the stream.
 
size_t write_vsprintf (_Printf_format_string_params_(2) const char *format, locale_t locale, va_list params)
 Writes formatted string to the stream.
 
size_t write_vsprintf (_Printf_format_string_params_(2) const wchar_t *format, locale_t locale, va_list params)
 Writes formatted string to the stream.
 
basicoperator>> (int8_t &data)
 
basicoperator<< (const int8_t data)
 
basicoperator>> (int16_t &data)
 
basicoperator<< (const int16_t data)
 
basicoperator>> (int32_t &data)
 
basicoperator<< (const int32_t data)
 
basicoperator>> (int64_t &data)
 
basicoperator<< (const int64_t data)
 
basicoperator>> (uint8_t &data)
 
basicoperator<< (const uint8_t data)
 
basicoperator>> (uint16_t &data)
 
basicoperator<< (const uint16_t data)
 
basicoperator>> (uint32_t &data)
 
basicoperator<< (const uint32_t data)
 
basicoperator>> (uint64_t &data)
 
basicoperator<< (const uint64_t data)
 
basicoperator>> (float &data)
 
basicoperator<< (const float data)
 
basicoperator>> (double &data)
 
basicoperator<< (const double data)
 
basicoperator>> (char &data)
 
basicoperator<< (const char data)
 
template<class T , class TR = std::char_traits<T>, class AX = std::allocator<T>>
basicoperator>> (std::basic_string< T, TR, AX > &data)
 
template<class T >
basicoperator<< (const T *data)
 
template<class T , class TR = std::char_traits<T>, class AX = std::allocator<T>>
basicoperator<< (const std::basic_string< T, TR, AX > &data)
 
template<class T , class AX = std::allocator<T>>
basicoperator<< (const std::vector< T, AX > &data)
 
template<class T , class AX = std::allocator<T>>
basicoperator>> (std::vector< T, AX > &data)
 
template<class KEY , class PR = std::less<KEY>, class AX = std::allocator<KEY>>
basicoperator<< (const std::set< KEY, PR, AX > &data)
 
template<class KEY , class PR = std::less<KEY>, class AX = std::allocator<KEY>>
basicoperator>> (std::set< KEY, PR, AX > &data)
 
template<class KEY , class PR = std::less<KEY>, class AX = std::allocator<KEY>>
basicoperator<< (const std::multiset< KEY, PR, AX > &data)
 
template<class KEY , class PR = std::less<KEY>, class AX = std::allocator<KEY>>
basicoperator>> (std::multiset< KEY, PR, AX > &data)
 

Protected Member Functions

void process ()
 

Protected Attributes

ring< uint8_t, N_cap > m_ring
 
std::thread m_worker
 
- Protected Attributes inherited from stdex::stream::converter
basicm_source
 
- Protected Attributes inherited from stdex::stream::basic
state_t m_state
 

Detailed Description

template<size_t N_cap = default_async_limit>
class stdex::stream::async_writer< N_cap >

Provides write-back stream capability.

Template Parameters
N_capWrite-back buffer size

Member Function Documentation

◆ flush()

template<size_t N_cap = default_async_limit>
virtual void stdex::stream::async_writer< N_cap >::flush ( )
inlinevirtual

Persists volatile element data.

Reimplemented from stdex::stream::converter.

◆ write()

template<size_t N_cap = default_async_limit>
virtual size_t stdex::stream::async_writer< N_cap >::write ( _In_reads_bytes_opt_(length) const void * data,
size_t length )
inlinevirtual

Writes block of data to the stream.

Parameters
[in]dataBuffer to write data from
[in]lengthNumber of bytes to write
Returns
Number of bytes successfully written. On error, stream state is set to state_t::fail.

Reimplemented from stdex::stream::converter.


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