Implements the common functionality needed for all Codecs More...

Inheritance diagram for DotZLib.CodecBase:

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

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

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

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

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

Protected Member Functions
void	OnDataAvailable ()
	Fires the DataAvailable event More...

abstract void	CleanUp ()
	Performs any codec specific cleanup 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...

Protected Attributes
bool	_isDisposed = false
	True if the object instance has been disposed, false otherwise More...

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

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

Properties
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
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...

Private Member Functions
	~CodecBase ()
	Destroys this instance More...

void	CleanUp (bool isDisposing)

Private Attributes
byte[]	_outBuffer = new byte[kBufferSize]

byte[]	_inBuffer = new byte[kBufferSize]

GCHandle	_hInput

GCHandle	_hOutput

uint	_checksum = 0

Detailed Description

Implements the common functionality needed for all Codecs

Definition at line 16 of file CodecBase.cs.

Constructor & Destructor Documentation

◆ CodecBase()

DotZLib.CodecBase.CodecBase ( )

inline

Initializes a new instance of the CodeBase class.

Definition at line 50 of file CodecBase.cs.

         {
             try
             {
                 _hInput = GCHandle.Alloc(_inBuffer, GCHandleType.Pinned);
                 _hOutput = GCHandle.Alloc(_outBuffer, GCHandleType.Pinned);
             }
             catch (Exception)
             {
                 CleanUp(false);
                 throw;
             }
         }

References DotZLib.CodecBase._hInput, DotZLib.CodecBase._hOutput, DotZLib.CodecBase._inBuffer, DotZLib.CodecBase._outBuffer, and DotZLib.CodecBase.CleanUp().

◆ ~CodecBase()

DotZLib.CodecBase.~CodecBase ( )

inlineprivate

Destroys this instance

Definition at line 123 of file CodecBase.cs.

         {
             CleanUp(false);
         }

References DotZLib.CodecBase.CleanUp().

Member Function Documentation

◆ Add() [1/2]

void DotZLib.CodecBase.Add ( byte[] data )

inline

Adds more data to the codec to be processed.

Parameters

data	Byte array containing the data to be added to the codec

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

Implements DotZLib.Codec.

Definition at line 90 of file CodecBase.cs.

         {
             Add(data,0,data.Length);
         }

◆ Add() [2/2]

abstract void DotZLib.CodecBase.Add	(	byte[]	data,
		int	offset,
		int	count
	)

pure virtual

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

This must be implemented by a derived class

Implements DotZLib.Codec.

Implemented in DotZLib.Inflater, and DotZLib.Deflater.

◆ CleanUp() [1/2]

abstract void DotZLib.CodecBase.CleanUp ( )

protectedpure virtual

Performs any codec specific cleanup

This must be implemented by a derived class

Implemented in DotZLib.Inflater, and DotZLib.Deflater.

Referenced by DotZLib.CodecBase.CleanUp(), DotZLib.CodecBase.CodecBase(), DotZLib.CodecBase.Dispose(), and DotZLib.CodecBase.~CodecBase().

◆ CleanUp() [2/2]

void DotZLib.CodecBase.CleanUp ( bool isDisposing )

inlineprivate

Definition at line 143 of file CodecBase.cs.

         {
             if (!_isDisposed)
             {
                 CleanUp();
                 if (_hInput.IsAllocated)
                     _hInput.Free();
                 if (_hOutput.IsAllocated)
                     _hOutput.Free();
  
                 _isDisposed = true;
             }
         }

References DotZLib.CodecBase._hInput, DotZLib.CodecBase._hOutput, DotZLib.CodecBase._isDisposed, and DotZLib.CodecBase.CleanUp().

◆ copyInput()

void DotZLib.CodecBase.copyInput	(	byte[]	data,
		int	startIndex,
		int	count
	)

inlineprotected

Copies a number of bytes to the internal codec buffer - ready for proccesing

Parameters

data	The byte array that contains the data to copy
startIndex	The index of the first byte to copy
count	The number of bytes to copy from `data`

Definition at line 168 of file CodecBase.cs.

         {
             Array.Copy(data, startIndex, _inBuffer,0, count);
             _ztream.next_in = _hInput.AddrOfPinnedObject();
             _ztream.total_in = 0;
             _ztream.avail_in = (uint)count;
  
         }

References DotZLib.CodecBase._hInput, DotZLib.CodecBase._inBuffer, DotZLib.CodecBase._ztream, Array, DotZLib.ZStream.avail_in, count, DotZLib.ZStream.next_in, and DotZLib.ZStream.total_in.

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

◆ Dispose()

void DotZLib.CodecBase.Dispose ( )

inline

Releases any unmanaged resources and calls the CleanUp() method of the derived class

Definition at line 131 of file CodecBase.cs.

         {
             CleanUp(true);
         }

References DotZLib.CodecBase.CleanUp().

◆ Finish()

abstract void DotZLib.CodecBase.Finish ( )

pure virtual

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

This must be implemented by a derived class

Implements DotZLib.Codec.

Implemented in DotZLib.Inflater, and DotZLib.Deflater.

◆ OnDataAvailable()

void DotZLib.CodecBase.OnDataAvailable ( )

inlineprotected

Fires the DataAvailable event

Definition at line 75 of file CodecBase.cs.

         {
             if (_ztream.total_out > 0)
             {
                 if (DataAvailable != null)
                     DataAvailable( _outBuffer, 0, (int)_ztream.total_out);
                 resetOutput();
             }
         }

References DotZLib.CodecBase._outBuffer, DotZLib.CodecBase._ztream, DotZLib.CodecBase.DataAvailable, DotZLib.CodecBase.resetOutput(), and DotZLib.ZStream.total_out.

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

◆ resetOutput()

void DotZLib.CodecBase.resetOutput ( )

inlineprotected

Resets the internal output buffers to a known state - ready for processing

Definition at line 180 of file CodecBase.cs.

         {
             _ztream.total_out = 0;
             _ztream.avail_out = kBufferSize;
             _ztream.next_out = _hOutput.AddrOfPinnedObject();
         }

References DotZLib.CodecBase._hOutput, DotZLib.CodecBase._ztream, DotZLib.ZStream.avail_out, DotZLib.CodecBase.kBufferSize, DotZLib.ZStream.next_out, and DotZLib.ZStream.total_out.

Referenced by DotZLib.Deflater.Deflater(), DotZLib.Deflater.Finish(), DotZLib.Inflater.Finish(), DotZLib.Inflater.Inflater(), and DotZLib.CodecBase.OnDataAvailable().

◆ setChecksum()

void DotZLib.CodecBase.setChecksum ( uint newSum )

inlineprotected

Updates the running checksum property

Parameters

newSum The new checksum value

Definition at line 191 of file CodecBase.cs.

         {
             _checksum = newSum;
         }

References DotZLib.CodecBase._checksum.

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

Member Data Documentation

◆ _checksum

uint DotZLib.CodecBase._checksum = 0

private

Definition at line 43 of file CodecBase.cs.

Referenced by DotZLib.CodecBase.setChecksum().

◆ _hInput

GCHandle DotZLib.CodecBase._hInput

private

Definition at line 40 of file CodecBase.cs.

Referenced by DotZLib.CodecBase.CleanUp(), DotZLib.CodecBase.CodecBase(), and DotZLib.CodecBase.copyInput().

◆ _hOutput

GCHandle DotZLib.CodecBase._hOutput

private

Definition at line 41 of file CodecBase.cs.

Referenced by DotZLib.CodecBase.CleanUp(), DotZLib.CodecBase.CodecBase(), and DotZLib.CodecBase.resetOutput().

◆ _inBuffer

byte [] DotZLib.CodecBase._inBuffer = new byte[kBufferSize]

private

Definition at line 38 of file CodecBase.cs.

Referenced by DotZLib.CodecBase.CodecBase(), and DotZLib.CodecBase.copyInput().

◆ _isDisposed

bool DotZLib.CodecBase._isDisposed = false

protected

True if the object instance has been disposed, false otherwise

Definition at line 30 of file CodecBase.cs.

Referenced by DotZLib.CodecBase.CleanUp().

◆ _outBuffer

byte [] DotZLib.CodecBase._outBuffer = new byte[kBufferSize]

private

Definition at line 37 of file CodecBase.cs.

Referenced by DotZLib.CodecBase.CodecBase(), and DotZLib.CodecBase.OnDataAvailable().

◆ _ztream

ZStream DotZLib.CodecBase._ztream = new ZStream()

package

Instance of the internal zlib buffer structure that is passed to all functions in the zlib dll

Definition at line 25 of file CodecBase.cs.

Referenced by DotZLib.Deflater.Add(), DotZLib.Inflater.Add(), DotZLib.Deflater.CleanUp(), DotZLib.Inflater.CleanUp(), DotZLib.CodecBase.copyInput(), DotZLib.Deflater.Deflater(), DotZLib.Deflater.Finish(), DotZLib.Inflater.Finish(), DotZLib.Inflater.Inflater(), DotZLib.CodecBase.OnDataAvailable(), and DotZLib.CodecBase.resetOutput().

◆ kBufferSize

const int DotZLib.CodecBase.kBufferSize = 16384

staticprotected

The size of the internal buffers

Definition at line 35 of file CodecBase.cs.

Referenced by DotZLib.Deflater.Add(), DotZLib.Inflater.Add(), and DotZLib.CodecBase.resetOutput().

Property Documentation

◆ Checksum

uint DotZLib.CodecBase.Checksum

get

Gets the checksum of the data that has been added so far

Definition at line 114 of file CodecBase.cs.

114 { get { return _checksum; } }

Event Documentation

◆ DataAvailable

DataAvailableHandler DotZLib.CodecBase.DataAvailable

Occurs when more processed data are available.

Definition at line 70 of file CodecBase.cs.

Referenced by DotZLib.CodecBase.OnDataAvailable().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Package Attributes

Properties

Events

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CodecBase()

◆ ~CodecBase()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ CleanUp() [1/2]

◆ CleanUp() [2/2]

◆ copyInput()

◆ Dispose()

◆ Finish()

◆ OnDataAvailable()

◆ resetOutput()

◆ setChecksum()

Member Data Documentation

◆ _checksum

◆ _hInput

◆ _hOutput

◆ _inBuffer

◆ _isDisposed

◆ _outBuffer

◆ _ztream

◆ kBufferSize

Property Documentation

◆ Checksum

Event Documentation

◆ DataAvailable