Security Scol plugin
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ZlibCompressor Class Reference

ZLIB Compressor (RFC 1950) More...

#include <zlib.h>

Inheritance diagram for ZlibCompressor:
Deflator LowFirstBitWriter Filter BufferedTransformation NotCopyable Algorithm Waitable Clonable

Public Member Functions

 ZlibCompressor (BufferedTransformation *attachment=NULLPTR, unsigned int deflateLevel=DEFAULT_DEFLATE_LEVEL, unsigned int log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE, bool detectUncompressible=true)
 
 ZlibCompressor (const NameValuePairs &parameters, BufferedTransformation *attachment=NULLPTR)
 
unsigned int GetCompressionLevel () const
 
- Public Member Functions inherited from Deflator
 Deflator (BufferedTransformation *attachment=NULLPTR, int deflateLevel=DEFAULT_DEFLATE_LEVEL, int log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE, bool detectUncompressible=true)
 Construct a Deflator compressor.
 
 Deflator (const NameValuePairs &parameters, BufferedTransformation *attachment=NULLPTR)
 Construct a Deflator compressor.
 
void SetDeflateLevel (int deflateLevel)
 Sets the deflation level.
 
int GetDeflateLevel () const
 Retrieves the deflation level.
 
int GetLog2WindowSize () const
 Retrieves the window size.
 
void IsolatedInitialize (const NameValuePairs &parameters)
 Initialize or reinitialize this object, without signal propagation.
 
size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing.
 
bool IsolatedFlush (bool hardFlush, bool blocking)
 Flushes data buffered by this object, without signal propagation.
 
- Public Member Functions inherited from LowFirstBitWriter
 LowFirstBitWriter (BufferedTransformation *attachment)
 Construct a LowFirstBitWriter.
 
void PutBits (unsigned long value, unsigned int length)
 
void FlushBitBuffer ()
 
void ClearBitBuffer ()
 
void StartCounting ()
 
unsigned long FinishCounting ()
 
- Public Member Functions inherited from Filter
 Filter (BufferedTransformation *attachment=NULLPTR)
 Construct a Filter.
 
bool Attachable ()
 Determine if attachable.
 
BufferedTransformationAttachedTransformation ()
 Retrieve attached transformation.
 
const BufferedTransformationAttachedTransformation () const
 Retrieve attached transformation.
 
void Detach (BufferedTransformation *newAttachment=NULLPTR)
 Replace an attached transformation.
 
size_t TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer bytes from this object to another BufferedTransformation.
 
size_t CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
 Copy bytes from this object to another BufferedTransformation.
 
void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 Initialize or reinitialize this object, with signal propagation.
 
bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output, with signal propagation.
 
bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 Marks the end of a series of messages, with signal propagation.
 
- Public Member Functions inherited from BufferedTransformation
 BufferedTransformation ()
 Construct a BufferedTransformation.
 
BufferedTransformationRef ()
 Provides a reference to this object.
 
virtual void Attach (BufferedTransformation *newAttachment)
 Add newAttachment to the end of attachment chain.
 
size_t Put (byte inByte, bool blocking=true)
 Input a byte for processing.
 
size_t Put (const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing.
 
size_t PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 
size_t PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 
size_t PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 
virtual byteCreatePutSpace (size_t &size)
 Request space which can be written into by the caller.
 
virtual bool CanModifyInput () const
 Determines whether input can be modified by the callee.
 
size_t PutModifiable (byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee.
 
bool MessageEnd (int propagation=-1, bool blocking=true)
 Signals the end of messages to the object.
 
size_t PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true)
 Input multiple bytes for processing and signal the end of a message.
 
virtual size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee.
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects.
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects.
 
virtual bool IsolatedMessageSeriesEnd (bool blocking)
 Marks the end of a series of messages, without signal propagation.
 
virtual void SetAutoSignalPropagation (int propagation)
 Set propagation of automatically generated and transferred signals.
 
virtual int GetAutoSignalPropagation () const
 Retrieve automatic signal propagation value.
 
virtual lword MaxRetrievable () const
 Provides the number of bytes ready for retrieval.
 
virtual bool AnyRetrievable () const
 Determines whether bytes are ready for retrieval.
 
virtual size_t Get (byte &outByte)
 Retrieve a 8-bit byte.
 
virtual size_t Get (byte *outString, size_t getMax)
 Retrieve a block of bytes.
 
virtual size_t Peek (byte &outByte) const
 Peek a 8-bit byte.
 
virtual size_t Peek (byte *outString, size_t peekMax) const
 Peek a block of bytes.
 
size_t GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 16-bit word.
 
size_t GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 32-bit word.
 
size_t GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 64-bit word.
 
size_t PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 16-bit word.
 
size_t PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 32-bit word.
 
size_t PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 64-bit word.
 
lword TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL)
 move transferMax bytes of the buffered output to target as input
 
virtual lword Skip (lword skipMax=LWORD_MAX)
 Discard skipMax bytes from the output buffer.
 
lword CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy bytes from this object to another BufferedTransformation.
 
lword CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy bytes from this object using an index to another BufferedTransformation.
 
virtual lword TotalBytesRetrievable () const
 Provides the number of bytes ready for retrieval.
 
virtual unsigned int NumberOfMessages () const
 Provides the number of meesages processed by this object.
 
virtual bool AnyMessages () const
 Determines if any messages are available for retrieval.
 
virtual bool GetNextMessage ()
 Start retrieving the next message.
 
virtual unsigned int SkipMessages (unsigned int count=UINT_MAX)
 Skip a number of meessages.
 
unsigned int TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
 Transfer messages from this object to another BufferedTransformation.
 
unsigned int CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation.
 
virtual void SkipAll ()
 Skip all messages in the series.
 
void TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
 Transfer all bytes from this object to another BufferedTransformation.
 
void CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation.
 
virtual bool GetNextMessageSeries ()
 Retrieve the next message in a series.
 
virtual unsigned int NumberOfMessagesInThisSeries () const
 Provides the number of messages in a series.
 
virtual unsigned int NumberOfMessageSeries () const
 Provides the number of messages in a series.
 
size_t TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer messages from this object to another BufferedTransformation.
 
size_t TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer all bytes from this object to another BufferedTransformation.
 
size_t ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
 Input a byte for processing on a channel.
 
size_t ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing on a channel.
 
size_t ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee on a channel.
 
size_t ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 16-bit word for processing on a channel.
 
size_t ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 32-bit word for processing on a channel.
 
size_t ChannelPutWord64 (const std::string &channel, word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 64-bit word for processing on a channel.
 
bool ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Signal the end of a message.
 
size_t ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true)
 Input multiple bytes for processing and signal the end of a message.
 
virtual byteChannelCreatePutSpace (const std::string &channel, size_t &size)
 Request space which can be written into by the caller.
 
virtual size_t ChannelPut2 (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing on a channel.
 
virtual size_t ChannelPutModifiable2 (const std::string &channel, byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee on a channel.
 
virtual bool ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output on a channel.
 
virtual bool ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Marks the end of a series of messages on a channel.
 
virtual void SetRetrievalChannel (const std::string &channel)
 Sets the default retrieval channel.
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms.
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm.
 
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object.
 
- Public Member Functions inherited from Waitable
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object.
 

Protected Member Functions

void WritePrestreamHeader ()
 
void ProcessUncompressedData (const byte *string, size_t length)
 
void WritePoststreamTail ()
 
- Protected Member Functions inherited from Deflator
void InitializeStaticEncoders ()
 
void Reset (bool forceReset=false)
 
unsigned int FillWindow (const byte *str, size_t length)
 
unsigned int ComputeHash (const byte *str) const
 
unsigned int LongestMatch (unsigned int &bestMatch) const
 
void InsertString (unsigned int start)
 
void ProcessBuffer ()
 
void LiteralByte (byte b)
 
void MatchFound (unsigned int distance, unsigned int length)
 
void EncodeBlock (bool eof, unsigned int blockType)
 
void EndBlock (bool eof)
 
- Protected Member Functions inherited from Filter
virtual BufferedTransformationNewDefaultAttachment () const
 
void Insert (Filter *nextFilter)
 
virtual bool ShouldPropagateMessageEnd () const
 
virtual bool ShouldPropagateMessageSeriesEnd () const
 
void PropagateInitialize (const NameValuePairs &parameters, int propagation)
 
size_t Output (int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Forward processed data on to attached transformation.
 
size_t OutputModifiable (int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Output multiple bytes that may be modified by callee.
 
bool OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Signals the end of messages to the object.
 
bool OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Flush buffered input and/or output, with signal propagation.
 
bool OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Marks the end of a series of messages, with signal propagation.
 

Protected Attributes

Adler32 m_adler32
 
- Protected Attributes inherited from Deflator
int m_deflateLevel
 
int m_log2WindowSize
 
int m_compressibleDeflateLevel
 
unsigned int m_detectSkip
 
unsigned int m_detectCount
 
unsigned int DSIZE
 
unsigned int DMASK
 
unsigned int HSIZE
 
unsigned int HMASK
 
unsigned int GOOD_MATCH
 
unsigned int MAX_LAZYLENGTH
 
unsigned int MAX_CHAIN_LENGTH
 
bool m_headerWritten
 
bool m_matchAvailable
 
unsigned int m_dictionaryEnd
 
unsigned int m_stringStart
 
unsigned int m_lookahead
 
unsigned int m_minLookahead
 
unsigned int m_previousMatch
 
unsigned int m_previousLength
 
HuffmanEncoder m_staticLiteralEncoder
 
HuffmanEncoder m_staticDistanceEncoder
 
HuffmanEncoder m_dynamicLiteralEncoder
 
HuffmanEncoder m_dynamicDistanceEncoder
 
SecByteBlock m_byteBuffer
 
SecBlock< word16m_head
 
SecBlock< word16m_prev
 
FixedSizeSecBlock< unsigned int, 286 > m_literalCounts
 
FixedSizeSecBlock< unsigned int, 30 > m_distanceCounts
 
SecBlock< EncodedMatchm_matchBuffer
 
unsigned int m_matchBufferEnd
 
unsigned int m_blockStart
 
unsigned int m_blockLength
 
- Protected Attributes inherited from LowFirstBitWriter
bool m_counting
 
unsigned long m_bitCount
 
unsigned long m_buffer
 
unsigned int m_bitsBuffered
 
unsigned int m_bytesBuffered
 
FixedSizeSecBlock< byte, 256 > m_outputBuffer
 
- Protected Attributes inherited from Filter
size_t m_inputPosition
 
int m_continueAt
 

Additional Inherited Members

- Public Types inherited from Deflator
enum  { MIN_DEFLATE_LEVEL = 0 , DEFAULT_DEFLATE_LEVEL = 6 , MAX_DEFLATE_LEVEL = 9 }
 Deflate level as enumerated values. More...
 
enum  { MIN_LOG2_WINDOW_SIZE = 9 , DEFAULT_LOG2_WINDOW_SIZE = 15 , MAX_LOG2_WINDOW_SIZE = 15 }
 Windows size as enumerated values. More...
 
- Protected Types inherited from Deflator
enum  { STORED = 0 , STATIC = 1 , DYNAMIC = 2 }
 
enum  { MIN_MATCH = 3 , MAX_MATCH = 258 }
 
- Static Protected Member Functions inherited from BufferedTransformation
static int DecrementPropagation (int propagation)
 Decrements the propagation count while clamping at 0.
 

Detailed Description

ZLIB Compressor (RFC 1950)

Definition at line 17 of file zlib.h.

Constructor & Destructor Documentation

◆ ZlibCompressor() [1/2]

ZlibCompressor::ZlibCompressor ( BufferedTransformation attachment = NULLPTR,
unsigned int  deflateLevel = DEFAULT_DEFLATE_LEVEL,
unsigned int  log2WindowSize = DEFAULT_LOG2_WINDOW_SIZE,
bool  detectUncompressible = true 
)
inline

Definition at line 20 of file zlib.h.

◆ ZlibCompressor() [2/2]

ZlibCompressor::ZlibCompressor ( const NameValuePairs parameters,
BufferedTransformation attachment = NULLPTR 
)
inline

Definition at line 22 of file zlib.h.

Member Function Documentation

◆ GetCompressionLevel()

unsigned int ZlibCompressor::GetCompressionLevel ( ) const

Definition at line 43 of file zlib.cpp.

◆ ProcessUncompressedData()

void ZlibCompressor::ProcessUncompressedData ( const byte string,
size_t  length 
)
protectedvirtual

Reimplemented from Deflator.

Definition at line 31 of file zlib.cpp.

◆ WritePoststreamTail()

void ZlibCompressor::WritePoststreamTail ( )
protectedvirtual

Reimplemented from Deflator.

Definition at line 36 of file zlib.cpp.

◆ WritePrestreamHeader()

void ZlibCompressor::WritePrestreamHeader ( )
protectedvirtual

Reimplemented from Deflator.

Definition at line 21 of file zlib.cpp.

Member Data Documentation

◆ m_adler32

Adler32 ZlibCompressor::m_adler32
protected

Definition at line 32 of file zlib.h.


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