servlet::basic_filtered_sink< CharT > Class Template Reference

Implementation of filtered sink. More...

#include <io_filter.h>

Inheritance diagram for servlet::basic_filtered_sink< CharT >:

Public Member Functions
	basic_filtered_sink (basic_sink< CharT > *sink)
	Constructs the object with the sink to which all filtered data will be passed. More...
	~basic_filtered_sink () noexceptoverride
	Destroys this object.
std::streamsize	write (CharT *s, std::streamsize n) override
	Writes the first n characters of array s into the sink. More...
void	flush () override
	Flush sink if it can be flushed. More...
void	add_filter (basic_out_filter< CharT > *filter, bool delete_after_use=true)
	Adds new filter to the end of the filter chain. More...
Public Member Functions inherited from servlet::basic_sink< CharT >
virtual	~basic_sink () noexcept=default
	Virtual constructor.

Detailed Description

template<typename CharT>
class servlet::basic_filtered_sink< CharT >

Implementation of filtered sink.

This implementation supports multiple filters arranged as a chain.

Template Parameters

CharT

character type

See Also

basic_sink

Constructor & Destructor Documentation

template<typename CharT >

servlet::basic_filtered_sink< CharT >::basic_filtered_sink ( basic_sink< CharT > *  sink )

inlineexplicit

Constructs the object with the sink to which all filtered data will be passed.

When this object is destroyed it will delete the sink as well.

Parameters

sink	Last sink to which all the filtered data will be passed

Member Function Documentation

template<typename CharT >

void servlet::basic_filtered_sink< CharT >::add_filter ( basic_out_filter< CharT > *  filter, bool  delete_after_use = true  )

inline

Adds new filter to the end of the filter chain.

Parameters

filter	Ponter to filter to add to the filter chain
delete_after_use	if this flag is true than the filter will be deleted on destruction of this object

template<typename CharT >

void servlet::basic_filtered_sink< CharT >::flush ( )

inlineoverridevirtual

Flush sink if it can be flushed.

Otherwise do nothing.

Reimplemented from servlet::basic_sink< CharT >.

template<typename CharT >

std::streamsize servlet::basic_filtered_sink< CharT >::write ( CharT *  s, std::streamsize  n  )

inlineoverridevirtual

Writes the first n characters of array s into the sink.

Parameters

s	Pointer to an array of at least n elements
n	Number of characters to write.

Returns

Number of successefully written characters

Implements servlet::basic_sink< CharT >.

---

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

• include/servlet/lib/io_filter.h