C# Class Plupload.PngEncoder.DeflaterOutputStream

A special stream deflating or compressing the bytes that are written to it. It uses a Deflater to perform actual deflating.
Authors of the original java version : Tom Tromey, Jochen Hoenicke

Inheritance: Stream

Exibir arquivo Open project: akoch-ov/dipstart-development Class Usage Examples

Protected Properties

Property	Type	Description
baseOutputStream_	Stream
deflater_	Deflater

Public Methods

Method	Description
BeginRead ( byte buffer, int offset, int count, AsyncCallback callback, object state ) : IAsyncResult	Asynchronous reads are not supported a NotSupportedException is always thrown
BeginWrite ( byte buffer, int offset, int count, AsyncCallback callback, object state ) : IAsyncResult	Asynchronous writes arent supported, a NotSupportedException is always thrown
Close ( ) : void	Calls Finish and closes the underlying stream when is true.
DeflaterOutputStream ( Stream baseOutputStream ) : System	Creates a new DeflaterOutputStream with a default Deflater and default buffer size.
DeflaterOutputStream ( Stream baseOutputStream, Deflater deflater ) : System	Creates a new DeflaterOutputStream with the given Deflater and default buffer size.
DeflaterOutputStream ( Stream baseOutputStream, Deflater deflater, int bufferSize ) : System	Creates a new DeflaterOutputStream with the given Deflater and buffer size.
Finish ( ) : void	Finishes the stream by calling finish() on the deflater.
Flush ( ) : void	Flushes the stream by calling Flush on the deflater and then on the underlying stream. This ensures that all bytes are flushed.
Read ( byte buffer, int offset, int count ) : int	Read a block of bytes from stream
ReadByte ( ) : int	Read a byte from stream advancing position by one
Seek ( long offset, SeekOrigin origin ) : long	Sets the current position of this stream to the given value. Not supported by this class!
SetLength ( long value ) : void	Sets the length of this stream to the given value. Not supported by this class!
Write ( byte buffer, int offset, int count ) : void	Writes bytes from an array to the compressed stream.
WriteByte ( byte value ) : void	Writes a single byte to the compressed output stream.

Protected Methods

Method	Description
Deflate ( ) : void	Deflates everything in the input buffers. This will call `def.deflate()` until all bytes from the input buffers are processed.
EncryptBlock ( byte buffer, int offset, int length ) : void	Encrypt a block of data
EncryptByte ( ) : byte	Encrypt a single byte
UpdateKeys ( byte ch ) : void	Update encryption keys

Method Details

BeginRead() public method

Asynchronous reads are not supported a NotSupportedException is always thrown

Any access

public BeginRead ( byte buffer, int offset, int count, AsyncCallback callback, object state ) : IAsyncResult
buffer	byte	The buffer to read into.
offset	int	The offset to start storing data at.
count	int	The number of bytes to read
callback	AsyncCallback	The async callback to use.
state	object	The state to use.
return	IAsyncResult

BeginWrite() public method

Asynchronous writes arent supported, a NotSupportedException is always thrown

Any access

public BeginWrite ( byte buffer, int offset, int count, AsyncCallback callback, object state ) : IAsyncResult
buffer	byte	The buffer to write.
offset	int	The offset to begin writing at.
count	int	The number of bytes to write.
callback	AsyncCallback	The to use.
state	object	The state object.
return	IAsyncResult

Close() public method

Calls Finish and closes the underlying stream when is true.

public Close ( ) : void
return	void

Deflate() protected method

Deflates everything in the input buffers. This will call def.deflate() until all bytes from the input buffers are processed.

protected Deflate ( ) : void
return	void

DeflaterOutputStream() public method

Creates a new DeflaterOutputStream with a default Deflater and default buffer size.

public DeflaterOutputStream ( Stream baseOutputStream ) : System
baseOutputStream	Stream	/// the output stream where deflated output should be written. ///
return	System

DeflaterOutputStream() public method

Creates a new DeflaterOutputStream with the given Deflater and default buffer size.

public DeflaterOutputStream ( Stream baseOutputStream, Deflater deflater ) : System
baseOutputStream	Stream	/// the output stream where deflated output should be written. ///
deflater	Deflater	/// the underlying deflater. ///
return	System

DeflaterOutputStream() public method

Creates a new DeflaterOutputStream with the given Deflater and buffer size.

/// bufsize is less than or equal to zero. /// /// baseOutputStream does not support writing /// /// deflater instance is null ///

public DeflaterOutputStream ( Stream baseOutputStream, Deflater deflater, int bufferSize ) : System
baseOutputStream	Stream	/// The output stream where deflated output is written. ///
deflater	Deflater	/// The underlying deflater to use ///
bufferSize	int	/// The buffer size to use when deflating ///
return	System

EncryptBlock() protected method

Encrypt a block of data

protected EncryptBlock ( byte buffer, int offset, int length ) : void
buffer	byte	/// Data to encrypt. NOTE the original contents of the buffer are lost ///
offset	int	/// Offset of first byte in buffer to encrypt ///
length	int	/// Number of bytes in buffer to encrypt ///
return	void

EncryptByte() protected method

Encrypt a single byte

protected EncryptByte ( ) : byte
return	byte

Finish() public method

Finishes the stream by calling finish() on the deflater.

/// Not all input is deflated ///

public Finish ( ) : void
return	void

Flush() public method

Flushes the stream by calling Flush on the deflater and then on the underlying stream. This ensures that all bytes are flushed.

public Flush ( ) : void
return	void

Read() public method

Read a block of bytes from stream

Any access

public Read ( byte buffer, int offset, int count ) : int
buffer	byte	The buffer to store read data in.
offset	int	The offset to start storing at.
count	int	The maximum number of bytes to read.
return	int

ReadByte() public method

Read a byte from stream advancing position by one

Any access

public ReadByte ( ) : int
return	int

Seek() public method

Sets the current position of this stream to the given value. Not supported by this class!

Any access

public Seek ( long offset, SeekOrigin origin ) : long
offset	long	The offset relative to the to seek.
origin	SeekOrigin	The to seek from.
return	long

SetLength() public method

Sets the length of this stream to the given value. Not supported by this class!

Any access

public SetLength ( long value ) : void
value	long	The new stream length.
return	void

UpdateKeys() protected method

Update encryption keys

protected UpdateKeys ( byte ch ) : void
ch	byte
return	void

Write() public method

Writes bytes from an array to the compressed stream.

public Write ( byte buffer, int offset, int count ) : void
buffer	byte	/// The byte array ///
offset	int	/// The offset into the byte array where to start. ///
count	int	/// The number of bytes to write. ///
return	void

WriteByte() public method

Writes a single byte to the compressed output stream.

public WriteByte ( byte value ) : void
value	byte	/// The byte value. ///
return	void

Property Details

baseOutputStream_ protected_oe property

Base stream the deflater depends on.

protected Stream baseOutputStream_
return	Stream

deflater_ protected_oe property

The deflater which is used to deflate the stream.

protected Deflater,Plupload.PngEncoder deflater_
return	Deflater