FrameImageParserBaseTTypeIdentifier, TOutputType Class

This class defines a basic implementation of parsing functionality suitable for automating the parsing of a binary data stream represented as frames with common headers and returning the parsed data via an event.

Definition

Namespace: Gemstone.IO.Parsing
Assembly: Gemstone.IO (in Gemstone.IO.dll) Version: 1.0.128 -- Release Build+2960d3f3619fdc53cad514a51817286dcfb19027
public abstract class FrameImageParserBase<TTypeIdentifier, TOutputType> : BinaryImageParserBase, 
	IFrameImageParser<TTypeIdentifier, TOutputType>, IBinaryImageParser, IProvideStatus
where TOutputType : Object, ISupportFrameImage<TTypeIdentifier>
Inheritance
Object    MarshalByRefObject    Stream    BinaryImageParserBase    FrameImageParserBaseTTypeIdentifier, TOutputType
Derived
Implements
IBinaryImageParser, IFrameImageParserTTypeIdentifier, TOutputType, IProvideStatus

Type Parameters

TTypeIdentifier
Type of identifier used to distinguish output types.
TOutputType
Type of the interface or class used to represent outputs.

Remarks

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

This class is more specific than the BinaryImageParserBase in that it can automate the parsing of a particular protocol that is formatted as a series of frames that have a common method of identification. Automation of type creation occurs by loading implementations of common types that implement the ISupportFrameImageTTypeIdentifier interface. The common method of identification is handled by creating a class derived from the ICommonHeaderTTypeIdentifier which primarily includes a TypeID property, but also should include any state information needed to parse a particular frame if necessary. Derived classes simply override the ParseCommonHeader(Byte, Int32, Int32) function in order to parse the ICommonHeaderTTypeIdentifier from a provided binary image.

Constructors

FrameImageParserBaseTTypeIdentifier, TOutputType Creates a new instance of the FrameImageParserBaseTTypeIdentifier, TOutputType class.

Properties

CanRead Gets a value indicating whether the current stream supports reading.
(Inherited from BinaryImageParserBase)
CanSeek Gets a value indicating whether the current stream supports seeking.
(Inherited from BinaryImageParserBase)
CanTimeoutGets 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.
(Inherited from BinaryImageParserBase)
Enabled Gets or sets a boolean value that indicates whether the frame image parser is currently enabled.
(Overrides Enabled)
Length The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Name Gets the name of BinaryImageParserBase.
(Inherited from BinaryImageParserBase)
Position The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
ProtocolSyncBytes Gets or sets synchronization bytes for this parsing implementation, if used.
(Inherited from BinaryImageParserBase)
ProtocolUsesSyncBytes Gets flag that determines if this protocol parsing implementation uses synchronization bytes.
(Inherited from BinaryImageParserBase)
QueuedOutputs Gets the total number of parsed outputs that are currently queued for publication, if any.
ReadTimeoutGets 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.
(Inherited from BinaryImageParserBase)
Status Gets current status of FrameImageParserBaseTTypeIdentifier, TOutputType.
(Overrides Status)
TotalProcessedBuffers Gets the total number of buffer images processed so far.
(Inherited from BinaryImageParserBase)
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)
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 FrameImageParserBaseTTypeIdentifier, TOutputType 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 When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from BinaryImageParserBase)
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.
OnBufferParsed Raises the BufferParsed event.
(Inherited from BinaryImageParserBase)
OnDataDiscarded(Byte[]) Raises the DataDiscarded event.
(Inherited from BinaryImageParserBase)
OnDataParsed Raises the DataParsed event.
OnDuplicateTypeHandlerEncountered Raises the DuplicateTypeHandlerEncountered event.
OnOutputTypeNotFound Raises the OutputTypeNotFound event.
OnParsingException(Exception) Raises the ParsingException event.
(Inherited from BinaryImageParserBase)
Parse(ISupportBinaryImage) Parses the object implementing the ISupportBinaryImage interface.
(Inherited from BinaryImageParserBase)
ParseCommonHeader Parses a common header instance that implements ICommonHeaderTTypeIdentifier for the output type represented in the binary image.
ParseFrame Output type specific frame parsing algorithm.
(Overrides ParseFrame(Byte[], Int32, Int32))
PublishParsedOutputAsyncQueue handler used to publish queued outputs.
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.
(Inherited from BinaryImageParserBase)
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)
ReadByteReads 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(Int64, SeekOrigin) The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
SetLength(Int64) The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Start Start the data parser.
(Overrides Start)
Start(IEnumerableType) Starts the data parser given the specified type implementations.
Stop Stops the streaming data parser.
(Inherited from BinaryImageParserBase)
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 sequence of bytes onto the stream for parsing.
(Inherited from BinaryImageParserBase)
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)
WriteByteWrites 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.
(Inherited from BinaryImageParserBase)
DataDiscarded Occurs when data image fails deserialized due to an exception.
(Inherited from BinaryImageParserBase)
DataParsed Occurs when a data image is deserialized successfully to one of the output types that the data image represents.
DuplicateTypeHandlerEncountered Occurs when more than one type has been defined that can deserialize the specified output type.
OutputTypeNotFound Occurs when matching an output type for deserializing the data image could not be found.
ParsingException Occurs when an Exception is encountered while attempting to parse data.
(Inherited from BinaryImageParserBase)

Fields

StreamInitialized Tracks if data stream has been initialized.
(Inherited from BinaryImageParserBase)
UnparsedBuffer Remaining unparsed buffer from last parsing execution, if any.
(Inherited from BinaryImageParserBase)

See Also