BinaryImageParserBase Class

This class defines the fundamental functionality for parsing any stream of binary data.

Definition

Namespace: Gemstone.IO.Parsing
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.110 -- Release Build+3e0464f4461df4d3e1175b13966eb47ff832554d

C#View Source Request Example

public abstract class BinaryImageParserBase : Stream, 
	IBinaryImageParser, IProvideStatus

VBView Source Request Example

Public MustInherit Class BinaryImageParserBase
	Inherits Stream
	Implements IBinaryImageParser, IProvideStatus

C++View Source Request Example

public ref class BinaryImageParserBase abstract : public Stream, 
	IBinaryImageParser, IProvideStatus

JavaScriptView Source Request Example

Gemstone.IO.Parsing.BinaryImageParserBase = function();

Type.createClass(
	'Gemstone.IO.Parsing.BinaryImageParserBase',
	Stream,
	Gemstone.IO.Parsing.IBinaryImageParser,
	Gemstone.IProvideStatus);

Inheritance: Object MarshalByRefObject Stream BinaryImageParserBase

Implements: IBinaryImageParser, IProvideStatus

Remarks

This parser is designed as a write-only stream such that data can come from any source.

Constructors

BinaryImageParserBase

Creates a new instance of the BinaryImageParserBase class.

Properties

CanRead	Gets a value indicating whether the current stream supports reading. (Overrides StreamCanRead)
CanSeek	Gets a value indicating whether the current stream supports seeking. (Overrides StreamCanSeek)
CanTimeout	Gets a value that determines whether the current stream can time out. (Inherited from Stream)
CanWrite	Gets a value indicating whether the current stream supports writing. (Overrides StreamCanWrite)
Enabled	Gets or sets a boolean value that indicates whether the data parser is currently enabled.
Length	The parser is designed as a write only stream, so this method is not implemented. (Overrides StreamLength)
Name	Gets the name of BinaryImageParserBase.
Position	The parser is designed as a write only stream, so this method is not implemented. (Overrides StreamPosition)
ProtocolSyncBytes	Gets or sets synchronization bytes for this parsing implementation, if used.
ProtocolUsesSyncBytes	Gets flag that determines if this protocol parsing implementation uses synchronization bytes.
ReadTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream)
RunTime	Gets the total amount of time, in seconds, that the BinaryImageParserBase has been active.
Status	Gets current status of BinaryImageParserBase.
TotalProcessedBuffers	Gets the total number of buffer images processed so far.
WriteTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream)

Methods

BeginRead	Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream)
BeginWrite	Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream)
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. (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)
CreateWaitHandle	Allocates a WaitHandle object. (Inherited from Stream) Obsolete.
Dispose	Releases all resources used by the Stream. (Inherited from Stream)
Dispose(Boolean)	Releases the unmanaged resources used by the Stream and optionally releases the managed resources. (Inherited from Stream)
DisposeAsync	Asynchronously releases the unmanaged resources used by the Stream. (Inherited from Stream)
EndRead	Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream)
EndWrite	Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
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. (Overrides StreamFlush)
FlushAsync	Asynchronously 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)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) Obsolete.
GetType	Gets the Type of the current instance. (Inherited from Object)
InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) Obsolete.
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
ObjectInvariant	Provides support for a Contract. (Inherited from Stream) Obsolete.
OnBufferParsed	Raises the BufferParsed event.
OnDataDiscarded	Raises the DataDiscarded event.
OnParsingException	Raises the ParsingException event.
Parse	Parses the object implementing the ISupportBinaryImage interface.
ParseFrame	Protocol specific frame parsing algorithm.
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)	The parser is designed as a write only stream, so this method is not implemented. (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)
ReadAtLeast	Reads 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)
ReadAtLeastAsync	Asynchronously 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 stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Inherited from Stream)
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)
Seek	The parser is designed as a write only stream, so this method is not implemented. (Overrides StreamSeek(Int64, SeekOrigin))
SetLength	The parser is designed as a write only stream, so this method is not implemented. (Overrides StreamSetLength(Int64))
Start	Start the streaming data parser.
Stop	Stops the streaming data parser.
ToString	Returns 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 sequence of bytes onto the stream for parsing. (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 position in the stream and advances the position within the stream by one byte. (Inherited from Stream)

Events

BufferParsed	Occurs when buffer parsing has completed.
DataDiscarded	Occurs when data image fails deserialized due to an exception.
ParsingException	Occurs when an Exception is encountered while attempting to parse data.

Fields

DefaultProtocolSyncBytes	Specifies the default value for the ProtocolSyncBytes property.
StreamInitialized	Tracks if data stream has been initialized.
UnparsedBuffer	Remaining unparsed buffer from last parsing execution, if any.

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)