telnetpp::options::mccp::decompressor Class Reference

Represents an object that can decompress arbitrary byte sequences. More...

#include <decompressor.hpp>

Inheritance diagram for telnetpp::options::mccp::decompressor:

Public Member Functions
virtual	~decompressor ()
	Destructor.
virtual std::tuple< telnetpp::u8stream, bool >	decompress (telnetpp::u8 byte)=0
	Decompress the given byte, and return a tuple of the decompressed data and a boolean that is set to true if this was the end of the decompression stream. More...
virtual void	end_decompression ()=0
	Ends the current decompression stream. More...

Detailed Description

Represents an object that can decompress arbitrary byte sequences.

Member Function Documentation

virtual std::tuple<telnetpp::u8stream, bool> telnetpp::options::mccp::decompressor::decompress ( telnetpp::u8  byte )

pure virtual

Decompress the given byte, and return a tuple of the decompressed data and a boolean that is set to true if this was the end of the decompression stream.

Exceptions

telnetpp::options::mccp::corrupted_stream_error

if data was passed that it could not decompress. I.e. the stream has been corrupted or otherwise constructed in an invalid manner.

Implemented in telnetpp::options::mccp::zlib::decompressor.

virtual void telnetpp::options::mccp::decompressor::end_decompression ( )

pure virtual

Ends the current decompression stream.

Any further calls to decompress continue as if the stream were created fresh.

Implemented in telnetpp::options::mccp::zlib::decompressor.

---

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

• include/telnetpp/options/mccp/decompressor.hpp