Class for decoding data streams encoded with ZPack compression methods. More...

#include <zpack.h>

Public Types
enum	DecodeResult { DECODE_OK , DECODE_ERR_INVALID_SIGNATURE , DECODE_INVALID_DATA }
	Enum representing the result of the decoding process. More...

Public Member Functions
void	SetIn (std::shared_ptr< Pipe::CPipe > pipe_in_)
	Sets the input pipe for the decoder.

void	SetOut (std::shared_ptr< Pipe::CPipe > pipe_out_)
	Sets the output pipe for the decoder.

CZPackDecoder::DecodeResult	Decode ()
	Decodes the data from the input pipe and writes it to the output pipe.

Detailed Description

Class for decoding data streams encoded with ZPack compression methods.

This class provides methods to set input and output pipes and to perform the decoding of data streams that were compressed using Huffman encoding, RLE, or no compression.

Member Enumeration Documentation

◆ DecodeResult

enum ZPack::CZPackDecoder::DecodeResult

Enum representing the result of the decoding process.

Enumerator
DECODE_OK	Decoding was successful.
DECODE_ERR_INVALID_SIGNATURE	Invalid signature in the encoded data.
DECODE_INVALID_DATA	Invalid data in the encoded stream.

Member Function Documentation

◆ Decode()

CZPackDecoder::DecodeResult CZPackDecoder::Decode ( )

Decodes the data from the input pipe and writes it to the output pipe.

Returns: The result of the decoding process.

◆ SetIn()

void CZPackDecoder::SetIn ( std::shared_ptr< Pipe::CPipe > pipe_in_ )

Sets the input pipe for the decoder.

Parameters

pipe_in_ Shared pointer to the input pipe.

◆ SetOut()

void CZPackDecoder::SetOut ( std::shared_ptr< Pipe::CPipe > pipe_out_ )

Sets the output pipe for the decoder.

Parameters

pipe_out_ Shared pointer to the output pipe.

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

include/zpack.h
src/zpack.cpp

Public Types