Implements a data compressor, using the deflate algorithm in the ZLib dll More...

Inheritance diagram for DotZLib.Deflater:

Public Member Functions
	Deflater (CompressLevel level)
	Constructs an new instance of the `Deflater` More...

override void	Add (byte[] data, int offset, int count)
	Adds more data to the codec to be processed. More...

override void	Finish ()
	Finishes up any pending data that needs to be processed and handled. More...

Public Member Functions inherited from DotZLib.CodecBase
	CodecBase ()
	Initializes a new instance of the `CodeBase` class. More...

void	Add (byte[] data)
	Adds more data to the codec to be processed. More...

void	Dispose ()
	Releases any unmanaged resources and calls the CleanUp() method of the derived class More...

Protected Member Functions
override void	CleanUp ()
	Closes the internal zlib deflate stream More...

Protected Member Functions inherited from DotZLib.CodecBase
void	OnDataAvailable ()
	Fires the DataAvailable event More...

void	copyInput (byte[] data, int startIndex, int count)
	Copies a number of bytes to the internal codec buffer - ready for proccesing More...

void	resetOutput ()
	Resets the internal output buffers to a known state - ready for processing More...

void	setChecksum (uint newSum)
	Updates the running checksum property More...

Private Member Functions
static int	deflateInit_ (ref ZStream sz, int level, string vs, int size)

static int	deflate (ref ZStream sz, int flush)

static int	deflateReset (ref ZStream sz)

static int	deflateEnd (ref ZStream sz)

Additional Inherited Members
Protected Attributes inherited from DotZLib.CodecBase
bool	_isDisposed = false
	True if the object instance has been disposed, false otherwise More...

Static Protected Attributes inherited from DotZLib.CodecBase
const int	kBufferSize = 16384
	The size of the internal buffers More...

Package Attributes inherited from DotZLib.CodecBase
ZStream	_ztream = new ZStream()
	Instance of the internal zlib buffer structure that is passed to all functions in the zlib dll More...

Properties inherited from DotZLib.CodecBase
uint	Checksum `[get]`
	Gets the checksum of the data that has been added so far More...

Properties inherited from DotZLib.Codec
uint	Checksum `[get]`
	Gets the checksum of the data that has been added so far More...

Events inherited from DotZLib.CodecBase
DataAvailableHandler	DataAvailable
	Occurs when more processed data are available. More...

Events inherited from DotZLib.Codec
DataAvailableHandler	DataAvailable
	Occurs when more processed data are available. More...

Detailed Description

Implements a data compressor, using the deflate algorithm in the ZLib dll

Definition at line 18 of file Deflater.cs.

Constructor & Destructor Documentation

◆ Deflater()

DotZLib.Deflater.Deflater ( CompressLevel level )

inline

Constructs an new instance of the Deflater

Parameters

level The compression level to use for this Deflater

Definition at line 38 of file Deflater.cs.

                                              : base()
         {
             int retval = deflateInit_(ref _ztream, (int)level, Info.Version, Marshal.SizeOf(_ztream));
             if (retval != 0)
                 throw new ZLibException(retval, "Could not initialize deflater");
  
             resetOutput();
         }

References DotZLib.CodecBase._ztream, DotZLib.Deflater.deflateInit_(), level, DotZLib.CodecBase.resetOutput(), and DotZLib.Info.Version.

Member Function Documentation

◆ Add()

override void DotZLib.Deflater.Add	(	byte[]	data,
		int	offset,
		int	count
	)

inlinevirtual

Adds more data to the codec to be processed.

Parameters

data	Byte array containing the data to be added to the codec
offset	The index of the first byte to add from `data`
count	The number of bytes to add

Adding data may, or may not, raise the DataAvailable event

Implements DotZLib.CodecBase.

Definition at line 54 of file Deflater.cs.

         {
             if (data == null) throw new ArgumentNullException();
             if (offset < 0 || count < 0) throw new ArgumentOutOfRangeException();
             if ((offset+count) > data.Length) throw new ArgumentException();
  
             int total = count;
             int inputIndex = offset;
             int err = 0;
  
             while (err >= 0 && inputIndex < total)
             {
                 copyInput(data, inputIndex, Math.Min(total - inputIndex, kBufferSize));
                 while (err >= 0 && _ztream.avail_in > 0)
                 {
                     err = deflate(ref _ztream, (int)FlushTypes.None);
                     if (err == 0)
                         while (_ztream.avail_out == 0)
                         {
                             OnDataAvailable();
                             err = deflate(ref _ztream, (int)FlushTypes.None);
                         }
                     inputIndex += (int)_ztream.total_in;
                 }
             }
             setChecksum( _ztream.adler );
         }

References DotZLib.CodecBase._ztream, DotZLib.ZStream.adler, DotZLib.ZStream.avail_in, DotZLib.ZStream.avail_out, DotZLib.CodecBase.copyInput(), count, DotZLib.Deflater.deflate(), err, int, DotZLib.CodecBase.kBufferSize, DotZLib.CodecBase.OnDataAvailable(), DotZLib.CodecBase.setChecksum(), and DotZLib.ZStream.total_in.

◆ CleanUp()

override void DotZLib.Deflater.CleanUp ( )

inlineprotectedvirtual

Closes the internal zlib deflate stream

Implements DotZLib.CodecBase.

Definition at line 103 of file Deflater.cs.

103 { deflateEnd(ref _ztream); }

DotZLib.Deflater.deflateEnd

static int deflateEnd(ref ZStream sz)

References DotZLib.CodecBase._ztream, and DotZLib.Deflater.deflateEnd().

◆ deflate()

static int DotZLib.Deflater.deflate	(	ref ZStream	sz,
		int	flush
	)

private

Referenced by DotZLib.Deflater.Add(), and DotZLib.Deflater.Finish().

◆ deflateEnd()

static int DotZLib.Deflater.deflateEnd ( ref ZStream sz )

private

Referenced by DotZLib.Deflater.CleanUp().

◆ deflateInit_()

static int DotZLib.Deflater.deflateInit_	(	ref ZStream	sz,
		int	level,
		string	vs,
		int	size
	)

private

Referenced by DotZLib.Deflater.Deflater().

◆ deflateReset()

static int DotZLib.Deflater.deflateReset ( ref ZStream sz )

private

Referenced by DotZLib.Deflater.Finish().

◆ Finish()

override void DotZLib.Deflater.Finish ( )

inlinevirtual

Finishes up any pending data that needs to be processed and handled.

Implements DotZLib.CodecBase.

Definition at line 86 of file Deflater.cs.

         {
             int err;
             do
             {
                 err = deflate(ref _ztream, (int)FlushTypes.Finish);
                 OnDataAvailable();
             }
             while (err == 0);
             setChecksum( _ztream.adler );
             deflateReset(ref _ztream);
             resetOutput();
         }

References DotZLib.CodecBase._ztream, DotZLib.ZStream.adler, DotZLib.Deflater.deflate(), DotZLib.Deflater.deflateReset(), err, DotZLib.CodecBase.OnDataAvailable(), DotZLib.CodecBase.resetOutput(), and DotZLib.CodecBase.setChecksum().

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

subprojects/zlib-1.2.12/contrib/dotzlib/DotZLib/Deflater.cs

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Deflater()

Member Function Documentation

◆ Add()

◆ CleanUp()

◆ deflate()

◆ deflateEnd()

◆ deflateInit_()

◆ deflateReset()

◆ Finish()