C# Class Revenj.Utility.ChunkedMemoryStream

In memory stream with 8192 blocks to avoid LOH issues. Since .NET places objects larger that 85000 bytes into LOH, avoid it as much as possible by using list of smaller blocks.

Inheritance: Stream

Exibir arquivo Open project: ngs-doo/revenj Class Usage Examples

Public Properties

Property	Type	Description
CharBuffer	char[]
SmallBuffer	char[]

Public Methods

Method	Description
ChunkedMemoryStream ( Stream another ) : System	Create in memory stream based on another stream. Provided stream will not be disposed.
ChunkedMemoryStream ( Stream another, bool dispose, bool reset ) : System	Create in memory stream based on another stream. Specify whether should provided stream be disposed after copying.
Close ( ) : void	Close current stream. Stream will be added to pool if required. Doesn't release allocated buffers
CopyTo ( ChunkedMemoryStream other ) : void
CopyTo ( Stream stream ) : void	Optimized version of copy to stream
CopyTo ( byte target, int offset ) : void	Copy stream to target buffer
Create ( ) : ChunkedMemoryStream	Create or get a new instance of memory stream Stream is bound to thread and must be released from the same thread
Equals ( Stream another ) : bool	Compare two streams. Length and content will be compared.
Flush ( ) : void	Flush stream. Does nothing.
GetReader ( ) : TextReader	Reuse same text reader on this stream.
GetWriter ( ) : TextWriter	Reuse same text writer on this stream.
Matches ( byte compare ) : bool	Check if stream starts with provided byte[] and matches it's length Provided byte[] must be smaller than 8192 bytes
Read ( byte buffer, int offset, int count ) : int	Read buffer from the stream. Can return less then specified count if remaining block size is less than specified count
ReadByte ( ) : int	Read a single byte
Reset ( ) : void	Set length and position to 0
Seek ( long offset, SeekOrigin origin ) : long	Seek to position in the stream.
Send ( Socket socket ) : void	Send entire stream to provided socket.
SetLength ( long value ) : void	Set new length of the stream. Adjusts the current position if new length is larger then it.
Static ( ) : ChunkedMemoryStream	Create reusable stream. Disposing the stream only has the effect of resetting it.
ToBase64Stream ( ) : Stream	Convert stream to Base 64 String representation in stream.
ToBase64Writer ( TextWriter sw ) : void	Convert stream to Base 64 String representation in the provided writer.
ToPostgresBytea ( TextWriter sw ) : void	Convert stream to Postgres representation of bytea
ToString ( ) : string	Show content of the stream as string
UseBufferedReader ( TextReader reader ) : BufferedTextReader	Reuse buffered text reader associated with this stream. Provide input text reader as data source. Buffered text reader will be initialized with provided input
UseBufferedReader ( string value ) : BufferedTextReader	Reuse buffered text reader associated with this stream. Provide input string as data source. Buffered text reader will be initialized with provided input
Write ( byte buffer, int offset, int count ) : void	Write buffer to stream. Advances current position by count. Increases length if necessary. New blocks will be added as required. It's best to use buffer of size 8192
WriteByte ( byte value ) : void	Write byte to stream. Advances current position by one. Adds a new block if necessary.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Dispose current stream. Stream will be added to pool if required. Used to reset position and length. Doesn't release allocated buffers

Private Methods

Method	Description
ChunkedMemoryStream ( ) : System
ChunkedMemoryStream ( byte block ) : System

Method Details

ChunkedMemoryStream() public method

Create in memory stream based on another stream. Provided stream will not be disposed.

public ChunkedMemoryStream ( Stream another ) : System
another	Stream	stream to copy
return	System

ChunkedMemoryStream() public method

Create in memory stream based on another stream. Specify whether should provided stream be disposed after copying.

public ChunkedMemoryStream ( Stream another, bool dispose, bool reset ) : System
another	Stream	stream to copy
dispose	bool	dispose provided stream
reset	bool	reset provided stream to original position
return	System

Close() public method

Close current stream. Stream will be added to pool if required. Doesn't release allocated buffers

public Close ( ) : void
return	void

CopyTo() public method

public CopyTo ( ChunkedMemoryStream other ) : void
other	ChunkedMemoryStream
return	void

CopyTo() public method

Optimized version of copy to stream

public CopyTo ( Stream stream ) : void
stream	Stream	destination stream
return	void

CopyTo() public method

Copy stream to target buffer

public CopyTo ( byte target, int offset ) : void
target	byte	target array buffer
offset	int	start at offset
return	void

Create() public static method

Create or get a new instance of memory stream Stream is bound to thread and must be released from the same thread

public static Create ( ) : ChunkedMemoryStream
return	ChunkedMemoryStream

Dispose() protected method

Dispose current stream. Stream will be added to pool if required. Used to reset position and length. Doesn't release allocated buffers

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

Equals() public method

Compare two streams. Length and content will be compared.

public Equals ( Stream another ) : bool
another	Stream	stream to compare
return	bool

Flush() public method

Flush stream. Does nothing.

public Flush ( ) : void
return	void

GetReader() public method

Reuse same text reader on this stream.

public GetReader ( ) : TextReader
return	TextReader

GetWriter() public method

Reuse same text writer on this stream.

public GetWriter ( ) : TextWriter
return	System.IO.TextWriter

Matches() public method

Check if stream starts with provided byte[] and matches it's length Provided byte[] must be smaller than 8192 bytes

public Matches ( byte compare ) : bool
compare	byte
return	bool

Read() public method

Read buffer from the stream. Can return less then specified count if remaining block size is less than specified count

public Read ( byte buffer, int offset, int count ) : int
buffer	byte	copy to buffer
offset	int	offset in the buffer
count	int	maximum size to read
return	int

ReadByte() public method

Read a single byte

public ReadByte ( ) : int
return	int

Reset() public method

Set length and position to 0

public Reset ( ) : void
return	void

Seek() public method

Seek to position in the stream.

public Seek ( long offset, SeekOrigin origin ) : long
offset	long	offset at stream
origin	SeekOrigin	position type
return	long

Send() public method

Send entire stream to provided socket.

public Send ( Socket socket ) : void
socket	System.Net.Sockets.Socket	where to send
return	void

SetLength() public method

Set new length of the stream. Adjusts the current position if new length is larger then it.

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

Static() public static method

Create reusable stream. Disposing the stream only has the effect of resetting it.

public static Static ( ) : ChunkedMemoryStream
return	ChunkedMemoryStream

ToBase64Stream() public method

Convert stream to Base 64 String representation in stream.

public ToBase64Stream ( ) : Stream
return	Stream

ToBase64Writer() public method

Convert stream to Base 64 String representation in the provided writer.

public ToBase64Writer ( TextWriter sw ) : void
sw	System.IO.TextWriter
return	void

ToPostgresBytea() public method

Convert stream to Postgres representation of bytea

public ToPostgresBytea ( TextWriter sw ) : void
sw	System.IO.TextWriter
return	void

ToString() public method

Show content of the stream as string

public ToString ( ) : string
return	string

UseBufferedReader() public method

Reuse buffered text reader associated with this stream. Provide input text reader as data source. Buffered text reader will be initialized with provided input

public UseBufferedReader ( TextReader reader ) : BufferedTextReader
reader	TextReader	input for processing
return	BufferedTextReader

UseBufferedReader() public method

Reuse buffered text reader associated with this stream. Provide input string as data source. Buffered text reader will be initialized with provided input

public UseBufferedReader ( string value ) : BufferedTextReader
value	string	input for processing
return	BufferedTextReader

Write() public method

Write buffer to stream. Advances current position by count. Increases length if necessary. New blocks will be added as required. It's best to use buffer of size 8192

public Write ( byte buffer, int offset, int count ) : void
buffer	byte	provided bytes
offset	int	offset in bytes
count	int	total length
return	void

WriteByte() public method

Write byte to stream. Advances current position by one. Adds a new block if necessary.

public WriteByte ( byte value ) : void
value	byte	byte to write
return	void

Property Details

CharBuffer public_oe property

Temporary char buffer for reuse (8192*4/3 + 2 chars)

public char[] CharBuffer
return	char[]

SmallBuffer public_oe property

Temporary small char buffer for reuse (64 chars)

public char[] SmallBuffer
return	char[]