Class ReadWriteRingBuffer

A fixed size buffer of bytes. Both reading and writing are supported. Reading from an empty buffer will wait until data is written. Writing to a full buffer will wait until data is read.

Inheritance

Object

ReadWriteRingBuffer

Namespace: ICSharpCode.SharpZipLib.Tests.TestSupport

Syntax

public class ReadWriteRingBuffer : object

Constructors

ReadWriteRingBuffer(Int32, Nullable<CancellationToken>)

Create a new RingBuffer with a specified size.

Declaration

public ReadWriteRingBuffer(int size, CancellationToken? token = null)

Parameters

Type	Name	Description
Int32	size	The size of the ring buffer to create.
Nullable<CancellationToken>	token

Properties

BytesRead

Declaration

public long BytesRead { get; }

Property Value

Type	Description
Int64

BytesWritten

Declaration

public long BytesWritten { get; }

Property Value

Type	Description
Int64

Count

Gets the number of elements in the buffer.

Declaration

public int Count { get; }

Property Value

Type	Description
Int32

IsClosed

Declaration

public bool IsClosed { get; }

Property Value

Type	Description
Boolean

IsEmpty

Gets a value indicating wether the buffer is empty or not.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
Boolean

IsFull

Declaration

public bool IsFull { get; }

Property Value

Type	Description
Boolean

Item[Int32]

Indexer - Get an element from the tail of the RingBuffer.

Declaration

public byte this[int index] { get; }

Parameters

Type	Name	Description
Int32	index

Property Value

Type	Description
Byte

Length

Declaration

public int Length { get; }

Property Value

Type	Description
Int32

Methods

Clear()

Clear the buffer contents.

Declaration

public void Clear()

Close()

Close the buffer for writing.

Declaration

public void Close()

Remarks

A Read when the buffer is closed and there is no data will return -1.

Read(Byte[], Int32, Int32)

Declaration

public int Read(byte[] buffer, int index, int count)

Parameters

Type	Name	Description
Byte[]	buffer
Int32	index
Int32	count

Returns

Type	Description
Int32

ReadByte()

Read a byte from the buffer.

Declaration

public int ReadByte()

Returns

Type	Description
Int32

Write(Byte[], Int32, Int32)

Declaration

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

Parameters

Type	Name	Description
Byte[]	buffer
Int32	index
Int32	count

WriteByte(Byte)

Write adds a byte to the head of the RingBuffer.

Declaration

public void WriteByte(byte value)

Parameters

Type	Name	Description
Byte	value	The value to add.