BlockAllocatedMemoryStream Class

Defines a stream whose backing store is memory. Externally this class operates similar to a MemoryStream, internally it uses dynamically allocated buffer blocks instead of one large contiguous array of data.

Definition

Namespace: Gemstone.IO
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.128 -- Release Build+d050cfc5563c89a1188cc3c6b2d417530856f490
public class BlockAllocatedMemoryStream : Stream
Inheritance
Object    MarshalByRefObject    Stream    BlockAllocatedMemoryStream

Remarks

The BlockAllocatedMemoryStream has two primary benefits over a normal MemoryStream, first, the allocation of a large contiguous array of data in MemoryStream can fail when the requested amount of contiguous memory is unavailable - the BlockAllocatedMemoryStream prevents this; second, a MemoryStream will constantly reallocate the buffer size as the stream grows and shrinks and then copy all the data from the old buffer to the new - the BlockAllocatedMemoryStream maintains its blocks over its life cycle, unless manually cleared, thus eliminating unnecessary allocations and garbage collections when growing and reusing a stream.

Important: Unlike MemoryStream, the BlockAllocatedMemoryStream will not use a user provided buffer as its backing buffer. Any user provided buffers used to instantiate the class will be copied into internally managed reusable memory buffers. Subsequently, the BlockAllocatedMemoryStream does not support the notion of a non-expandable stream. If you are using a MemoryStream with your own buffer, the BlockAllocatedMemoryStream will not provide any immediate benefit.

Note that the BlockAllocatedMemoryStream will maintain all allocated blocks for stream use until the Clear method is called or the class is disposed.

No members in the BlockAllocatedMemoryStream are guaranteed to be thread safe. Make sure any calls are synchronized when simultaneously accessed from different threads.

Constructors

BlockAllocatedMemoryStream Initializes a new instance of BlockAllocatedMemoryStream.
BlockAllocatedMemoryStream(Byte) Initializes a new instance of BlockAllocatedMemoryStream from specified buffer.
BlockAllocatedMemoryStream(Int32) Initializes a new instance of BlockAllocatedMemoryStream for specified capacity.
BlockAllocatedMemoryStream(Byte, Int32, Int32) Initializes a new instance of BlockAllocatedMemoryStream from specified region of buffer.

Properties

CanRead Gets a value that indicates whether the BlockAllocatedMemoryStream object supports reading.
(Overrides StreamCanRead)
CanSeek Gets a value that indicates whether the BlockAllocatedMemoryStream object supports seeking.
(Overrides StreamCanSeek)
CanTimeoutGets a value that determines whether the current stream can time out.
(Inherited from Stream)
CanWrite Gets a value that indicates whether the BlockAllocatedMemoryStream object supports writing.
(Overrides StreamCanWrite)
Length Gets current stream length for this BlockAllocatedMemoryStream instance.
(Overrides StreamLength)
Position Gets current stream position for this BlockAllocatedMemoryStream instance.
(Overrides StreamPosition)
ReadTimeoutGets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream)
WriteTimeoutGets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream)

Methods

BeginReadBegins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
BeginWriteBegins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Clear Clears the entire BlockAllocatedMemoryStream contents and releases any allocated memory blocks.
CloseCloses 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.
(Inherited from Stream)
CopyTo(Stream)Reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied.
(Inherited from Stream)
CopyTo(Stream, Int32)Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied.
(Inherited from Stream)
CopyToAsync(Stream)Asynchronously reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied.
(Inherited from Stream)
CopyToAsync(Stream, Int32)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied.
(Inherited from Stream)
CopyToAsync(Stream, CancellationToken)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token. Both streams positions are advanced by the number of bytes copied.
(Inherited from Stream)
CopyToAsync(Stream, Int32, CancellationToken)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. Both streams positions are advanced by the number of bytes copied.
(Inherited from Stream)
CreateWaitHandleAllocates a WaitHandle object.
(Inherited from Stream)
Obsolete.
DisposeReleases all resources used by the Stream.
(Inherited from Stream)
Dispose(Boolean) Releases the unmanaged resources used by the BlockAllocatedMemoryStream object and optionally releases the managed resources.
(Overrides StreamDispose(Boolean))
DisposeAsyncAsynchronously releases the unmanaged resources used by the Stream.
(Inherited from Stream)
EndReadWaits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
EndWriteEnds an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Flush Overrides the Flush method so that no action is performed.
(Overrides StreamFlush)
FlushAsyncAsynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from Stream)
FlushAsync(CancellationToken)Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
(Inherited from Stream)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Obsolete.
GetTypeGets the Type of the current instance.
(Inherited from Object)
InitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Obsolete.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
ObjectInvariantProvides support for a Contract.
(Inherited from Stream)
Obsolete.
Read(SpanByte)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.
(Inherited from Stream)
Read(Byte, Int32, Int32) Reads a block of bytes from the current stream and writes the data to buffer.
(Overrides StreamRead(Byte, Int32, Int32))
ReadAsync(MemoryByte, CancellationToken)Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
(Inherited from Stream)
ReadAsync(Byte, Int32, Int32)Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Inherited from Stream)
ReadAsync(Byte, Int32, Int32, CancellationToken)Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
(Inherited from Stream)
ReadAtLeastReads at least a minimum number of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Inherited from Stream)
ReadAtLeastAsyncAsynchronously reads at least a minimum number of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
(Inherited from Stream)
ReadByte Reads a byte from the current stream.
(Overrides StreamReadByte)
ReadExactly(SpanByte)Reads bytes from the current stream and advances the position within the stream until the buffer is filled.
(Inherited from Stream)
ReadExactly(Byte, Int32, Int32)Reads count number of bytes from the current stream and advances the position within the stream.
(Inherited from Stream)
ReadExactlyAsync(MemoryByte, CancellationToken)Asynchronously reads bytes from the current stream, advances the position within the stream until the buffer is filled, and monitors cancellation requests.
(Inherited from Stream)
ReadExactlyAsync(Byte, Int32, Int32, CancellationToken)Asynchronously reads count number of bytes from the current stream, advances the position within the stream, and monitors cancellation requests.
(Inherited from Stream)
ReadFrom Reads specified number of bytes from source stream into this BlockAllocatedMemoryStream starting at the current position.
Seek Sets the Position within the current stream to the specified value relative the origin.
(Overrides StreamSeek(Int64, SeekOrigin))
SetLength Sets the length of the current stream to the specified value.
(Overrides StreamSetLength(Int64))
ToArray Writes the stream contents to a byte array, regardless of the Position property.
ToStringReturns a string that represents the current object.
(Inherited from Object)
Write(ReadOnlySpanByte)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.
(Inherited from Stream)
Write(Byte, Int32, Int32) Writes a block of bytes to the current stream using data read from buffer.
(Overrides StreamWrite(Byte, Int32, Int32))
WriteAsync(ReadOnlyMemoryByte, CancellationToken)Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
(Inherited from Stream)
WriteAsync(Byte, Int32, Int32)Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Inherited from Stream)
WriteAsync(Byte, Int32, Int32, CancellationToken)Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
(Inherited from Stream)
WriteByte Writes a byte to the current stream at the current position.
(Overrides StreamWriteByte(Byte))
WriteTo Writes the entire stream into destination, regardless of Position, which remains unchanged.

Extension Methods

CopyTo Writes the contents of a stream to the provided stream.
(Defined by StreamExtensions)
GetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
GetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Read7BitUInt32 Reads the 7-bit encoded value from the stream.
(Defined by StreamExtensions)
ReadAll Reads all of the provided bytes. Will not return prematurely, but continue to execute a Read(Byte, Int32, Int32) command until the entire length has been read.
(Defined by StreamExtensions)
ReadBoolean Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
ReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
ReadChar Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadDateTime Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadDecimal Reads a decimal from the stream in Little Endian bytes.
(Defined by StreamExtensions)
ReadDouble Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadGuid Reads a Guid from the stream in Little Endian bytes.
(Defined by StreamExtensions)
ReadInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadInt32Collection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
ReadInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadNextByte Read a byte from the stream. Will throw an exception if the end of the stream has been reached.
(Defined by StreamExtensions)
ReadNullableString Reads a string from a Stream that was encoded in UTF8. Value can be null and is prefixed with a boolean.
(Defined by StreamExtensions)
ReadObject Reads an object from a stream.
(Defined by StreamExtensions)
ReadSByte Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadSingle Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadStream Reads entire Stream contents, and returns Byte array of data.
(Defined by StreamExtensions)
ReadString Reads a string from a Stream that was encoded in UTF8.
(Defined by StreamExtensions)
ReadStringCollection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
ReadUInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadUInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
ReadUInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to in little endian format.
(Defined by StreamExtensions)
Write Writes the entire buffer to the stream
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes a guid in little endian bytes to the stream
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
WriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
WriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
WriteNullable Writes the supplied string to a Stream in UTF8 encoding with a prefix if the value is null
(Defined by StreamExtensions)
WriteObject Encodes an object on a stream.
(Defined by StreamExtensions)
WriteWithLength Writes the supplied value to stream along with prefixing the length so it can be properly read as a unit.
(Defined by StreamExtensions)

See Also