Gemstone IO Library
Show/Hide TOC

# MultiSourceFrameImageParserBase TSourceIdentifier, TTypeIdentifier, TOutputType Class

This class defines a basic implementation of parsing functionality suitable for automating the parsing of multiple binary data streams, each 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.159 -- Release Build+ba5688372d08d23734a863a87183685f0687ec86
C#
View Source Request Example

    public abstract class MultiSourceFrameImageParserBase<TSourceIdentifier, TTypeIdentifier, TOutputType> : FrameImageParserBase<TTypeIdentifier, TOutputType>
    where TOutputType : Object, ISupportSourceIdentifiableFrameImage<TSourceIdentifier, TTypeIdentifier>

VB
View Source Request Example

    Public MustInherit Class MultiSourceFrameImageParserBase(Of TSourceIdentifier, TTypeIdentifier, TOutputType As {Object, ISupportSourceIdentifiableFrameImage(Of TSourceIdentifier, TTypeIdentifier)})
    	Inherits FrameImageParserBase(Of TTypeIdentifier, TOutputType)

C++
View Source Request Example

    generic<typename TSourceIdentifier, typename TTypeIdentifier, typename TOutputType>
    where TOutputType : Object, ISupportSourceIdentifiableFrameImage<TSourceIdentifier, TTypeIdentifier>
    public ref class MultiSourceFrameImageParserBase abstract : public FrameImageParserBase<TTypeIdentifier, TOutputType>

JavaScript
View Source Request Example

    JavaScript does not support generic types or methods.

Inheritance
  Object MarshalByRefObject Stream BinaryImageParserBase FrameImageParserBase TTypeIdentifier, TOutputType MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType

#### Type Parameters

TSourceIdentifier
  Type of identifier for the data source.
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 ISupportSourceIdentifiableFrameImageTSourceIdentifier, TTypeIdentifier 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 override the ParseCommonHeader(Byte, Int32, Int32) method in order to parse the ICommonHeaderTTypeIdentifier from a provided binary image.

## Constructors

MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType | Creates a new instance of the MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, 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)
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. (Inherited from BinaryImageParserBase)
Enabled | Gets or sets a boolean value that indicates whether the frame image parser is currently enabled. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
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)
QueuedBuffers | Gets the total number of buffers that are currently queued for processing, if any.
QueuedOutputs | Gets the total number of parsed outputs that are currently queued for publication, if any. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
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. (Inherited from BinaryImageParserBase)
Status | Gets current status of FrameImageParserBaseTTypeIdentifier, TOutputType. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
TotalProcessedBuffers | Gets the total number of buffer images processed so far. (Inherited from BinaryImageParserBase)
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 FrameImageParserBaseTTypeIdentifier, TOutputType object and optionally releases the managed resources. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
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. (Inherited from BinaryImageParserBase)
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. (Inherited from BinaryImageParserBase)
OnDataDiscarded | Raises the DataDiscarded event. (Overrides OnDataDiscarded(Byte[]))
OnDataParsed | Raises the DataParsed event. (Overrides FrameImageParserBaseTTypeIdentifier, TOutputType OnDataParsed(TOutputType))
OnDuplicateTypeHandlerEncountered | Raises the DuplicateTypeHandlerEncountered event. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
OnOutputTypeNotFound | Raises the OutputTypeNotFound event. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
OnParsingException(Exception) | Raises the ParsingException event. (Inherited from BinaryImageParserBase)
OnSourceDataParsed | Raises the SourceDataParsed event.
Parse(ISupportBinaryImage) | Not implemented. Consumers should call the Parse(TSourceIdentifier, ISupportBinaryImage) method instead to make sure data source ID gets tracked with data buffer. (Overrides Parse(ISupportBinaryImage)) Obsolete.
Parse(TSourceIdentifier, ISupportBinaryImage) | Queues the object implementing the ISupportBinaryImage interface, from the specified data source, onto the stream for parsing.
Parse(TSourceIdentifier, Byte) | Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
Parse(TSourceIdentifier, Byte, Int32, Int32) | Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
ParseCommonHeader | Parses a common header instance that implements ICommonHeaderTTypeIdentifier for the output type represented in the binary image. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
ParseFrame | Output type specific frame parsing algorithm. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
PublishParsedOutput | AsyncQueue handler used to publish queued outputs. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
PurgeBuffer | Clears the internal buffer of unparsed data received from the specified source.
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)
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(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 streaming data parser. (Overrides FrameImageParserBaseTTypeIdentifier, TOutputType Start)
Start(IEnumerableType) | Starts the data parser given the specified type implementations. (Overrides FrameImageParserBaseTTypeIdentifier, TOutputType Start(IEnumerableType))
Stop | Stops the streaming data parser. (Inherited from BinaryImageParserBase)
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) | Not implemented. Consumers should call the Parse(TSourceIdentifier, Byte, Int32, Int32) method instead to make sure data source ID gets tracked with data buffer. (Overrides Write(Byte[], Int32, Int32)) Obsolete.
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. (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. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
DuplicateTypeHandlerEncountered | Occurs when more than one type has been defined that can deserialize the specified output type. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
OutputTypeNotFound | Occurs when matching an output type for deserializing the data image could not be found. (Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
ParsingException | Occurs when an Exception is encountered while attempting to parse data. (Inherited from BinaryImageParserBase)
SourceDataParsed | Occurs when a data image is deserialized successfully to one or more of the output types that the data image represents.

## 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

#### Reference

Gemstone.IO.Parsing Namespace