StreamPeerGZip

A stream peer that handles GZIP and deflate compression/decompression.

This class allows to compress or decompress data using GZIP/deflate in a streaming fashion. This is particularly useful when compressing or decompressing files that have to be sent through the network without needing to allocate them all in memory. After starting the stream via StreamPeerGZip.StartCompression (or StreamPeerGZip.StartDecompression), calling StreamPeer.PutPartialData on this stream will compress (or decompress) the data, writing it to the internal buffer. Calling StreamPeer.GetAvailableBytes will return the pending bytes in the internal buffer, and StreamPeer.GetPartialData will retrieve the compressed (or decompressed) bytes from it. When the stream is over, you must call StreamPeerGZip.Finish to ensure the internal buffer is properly flushed (make sure to call StreamPeer.GetAvailableBytes on last time to check if more data needs to be read after that).

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

public StreamPeerGZip();

public void Clear();

public Error Finish();

public Error StartCompression(bool useDeflate = false, int bufferSize = 65535);

public Error StartDecompression(bool useDeflate = false, int bufferSize = 65535);