C# Class NanoByte.Common.Streams.CircularBufferStream

A circular buffer represented as a stream that one producer can write to and one consumer can read from simultaneously.

Do not use more than one producer or consumer thread simultaneously!

Inheritance: Stream

Public Methods

Method	Description
CircularBufferStream ( int bufferSize ) : System	Creates a new circular buffer.
DoneWriting ( ) : void	Signals that no further calls to Write are intended and any blocked Read calls should return.
Flush ( ) : void
Read ( byte buffer, int offset, int count ) : int
RelayErrorToReader ( Exception exception ) : void	Throws an exception from within Read.
Seek ( long offset, SeekOrigin origin ) : long
SetLength ( long value ) : void	Sets the estimated number of bytes that will run through this buffer in total; -1 for unknown.
Write ( byte buffer, int offset, int count ) : void

Method	Description
Dispose ( bool disposing ) : void

Creates a new circular buffer.

public CircularBufferStream ( int bufferSize ) : System
bufferSize	int	The maximum number of bytes the buffer can hold at any time.
return	System

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

Signals that no further calls to Write are intended and any blocked Read calls should return.

public DoneWriting ( ) : void
return	void

public Flush ( ) : void
return	void

public Read ( byte buffer, int offset, int count ) : int
buffer	byte
offset	int
count	int
return	int

Throws an exception from within Read.

public RelayErrorToReader ( Exception exception ) : void
exception	System.Exception	The exception to throw.
return	void

public Seek ( long offset, SeekOrigin origin ) : long
offset	long
origin	SeekOrigin
return	long

Sets the estimated number of bytes that will run through this buffer in total; -1 for unknown.

public SetLength ( long value ) : void
value	long
return	void

public Write ( byte buffer, int offset, int count ) : void
buffer	byte
offset	int
count	int
return	void