Class CompressedFileStream

Inheritance

object

MarshalByRefObject

Stream

CompressedFileStream

Implements

IAsyncDisposable

IDisposable

Inherited Members

Stream.Null

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.DisposeAsync()

Stream.EndRead(IAsyncResult)

Stream.EndWrite(IAsyncResult)

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.Read(Span<byte>)

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(byte[], int, int, CancellationToken)

Stream.ReadAsync(Memory<byte>, CancellationToken)

Stream.ReadAtLeast(Span<byte>, int, bool)

Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken)

Stream.ReadByte()

Stream.ReadExactly(byte[], int, int)

Stream.ReadExactly(Span<byte>)

Stream.ReadExactlyAsync(byte[], int, int, CancellationToken)

Stream.ReadExactlyAsync(Memory<byte>, CancellationToken)

Stream.Synchronized(Stream)

Stream.Write(ReadOnlySpan<byte>)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(byte[], int, int, CancellationToken)

Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Stream.WriteByte(byte)

Stream.CanTimeout

Stream.ReadTimeout

Stream.WriteTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Tenray.ZoneTree.WAL

Assembly: ZoneTree.dll

Syntax

public sealed class CompressedFileStream : Stream, IAsyncDisposable, IDisposable

Constructors

CompressedFileStream(ILogger, IFileStreamProvider, string, int, bool, int, CompressionMethod, int)

Declaration

public CompressedFileStream(ILogger logger, IFileStreamProvider fileStreamProvider, string filePath, int blockSize, bool enableTailWriterJob, int tailWriterJobInterval, CompressionMethod compressionMethod, int compressionLevel)

Parameters

Type	Name	Description
ILogger	logger
IFileStreamProvider	fileStreamProvider
string	filePath
int	blockSize
bool	enableTailWriterJob
int	tailWriterJobInterval
CompressionMethod	compressionMethod
int	compressionLevel

Properties

CanRead

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

Declaration

public override bool CanRead { get; }

Property Value

Type	Description
bool	true if the stream supports reading; otherwise, false.

Overrides

Stream.CanRead

CanSeek

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

Declaration

public override bool CanSeek { get; }

Property Value

Type	Description
bool	true if the stream supports seeking; otherwise, false.

Overrides

Stream.CanSeek

CanWrite

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

Declaration

public override bool CanWrite { get; }

Property Value

Type	Description
bool	true if the stream supports writing; otherwise, false.

Overrides

Stream.CanWrite

FilePath

Declaration

public string FilePath { get; }

Property Value

Type	Description
string

Length

When overridden in a derived class, gets the length in bytes of the stream.

Declaration

public override long Length { get; }

Property Value

Type	Description
long	A long value representing the length of the stream in bytes.

Overrides

Stream.Length

Exceptions

Type	Condition
NotSupportedException	A class derived from Stream does not support seeking and the length is unknown.
ObjectDisposedException	Methods were called after the stream was closed.

Position

When overridden in a derived class, gets or sets the position within the current stream.

Declaration

public override long Position { get; set; }

Property Value

Type	Description
long	The current position within the stream.

Overrides

Stream.Position

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support seeking.
ObjectDisposedException	Methods were called after the stream was closed.

Methods

Close()

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.

Declaration

public override void Close()

Overrides

Stream.Close()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

Overrides

Stream.Dispose(bool)

Flush()

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

Declaration

public override void Flush()

Overrides

Stream.Flush()

Exceptions

Type	Condition
IOException	An I/O error occurs.

GetFileContent()

Declaration

public byte[] GetFileContent()

Returns

Type	Description
byte[]

GetFileContentIncludingTail()

Declaration

public byte[] GetFileContentIncludingTail()

Returns

Type	Description
byte[]

Read(byte[], int, int)

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Declaration

public override int Read(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer	An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
int	offset	The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
int	count	The maximum number of bytes to be read from the current stream.

Returns

Type	Description
int	The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Overrides

Stream.Read(byte[], int, int)

Exceptions

Type	Condition
ArgumentException	The sum of offset and count is larger than the buffer length.
ArgumentNullException	buffer is null.
ArgumentOutOfRangeException	offset or count is negative.
IOException	An I/O error occurs.
NotSupportedException	The stream does not support reading.
ObjectDisposedException	Methods were called after the stream was closed.

Seek(long, SeekOrigin)

When overridden in a derived class, sets the position within the current stream.

Declaration

public override long Seek(long offset, SeekOrigin origin)

Parameters

Type	Name	Description
long	offset	A byte offset relative to the origin parameter.
SeekOrigin	origin	A value of type SeekOrigin indicating the reference point used to obtain the new position.

Returns

Type	Description
long	The new position within the current stream.

Overrides

Stream.Seek(long, SeekOrigin)

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException	Methods were called after the stream was closed.

SetLength(long)

When overridden in a derived class, sets the length of the current stream.

Declaration

public override void SetLength(long value)

Parameters

Type	Name	Description
long	value	The desired length of the current stream in bytes.

Overrides

Stream.SetLength(long)

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException	Methods were called after the stream was closed.

Write(byte[], int, int)

When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Declaration

public override void Write(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer	An array of bytes. This method copies count bytes from buffer to the current stream.
int	offset	The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
int	count	The number of bytes to be written to the current stream.

Overrides

Stream.Write(byte[], int, int)

Exceptions

Type	Condition
ArgumentException	The sum of offset and count is greater than the buffer length.
ArgumentNullException	buffer is null.
ArgumentOutOfRangeException	offset or count is negative.
IOException	An I/O error occurred, such as the specified file cannot be found.
NotSupportedException	The stream does not support writing.
ObjectDisposedException	Write(byte[], int, int) was called after the stream was closed.

WriteTail()

Declaration

public void WriteTail()

Implements

IAsyncDisposable

IDisposable