FrameParserBaseTFrameIdentifier Class

Represents a frame parser that defines the basic functionality for a protocol to parse a binary data stream and return the parsed data via events.

Definition

Namespace: Gemstone.PhasorProtocols
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.128 -- Release Build+dd7f32701ba80de4d5b0557e84e0ddc18a34573f

C#View Source Request Example

public abstract class FrameParserBase<TFrameIdentifier> : MultiSourceFrameImageParserBase<SourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImage<SourceChannel, TFrameIdentifier>>, 
	IFrameParser, IProvideStatus, IDisposable

VBView Source Request Example

Public MustInherit Class FrameParserBase(Of TFrameIdentifier)
	Inherits MultiSourceFrameImageParserBase(Of SourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImage(Of SourceChannel, TFrameIdentifier))
	Implements IFrameParser, IProvideStatus, IDisposable

C++View Source Request Example

generic<typename TFrameIdentifier>
public ref class FrameParserBase abstract : public MultiSourceFrameImageParserBase<SourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImage<SourceChannel, TFrameIdentifier>^>, 
	IFrameParser, IProvideStatus, IDisposable

JavaScriptView Source Request Example

JavaScript does not support generic types or methods.

Inheritance: Object MarshalByRefObject Stream BinaryImageParserBase FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier FrameParserBaseTFrameIdentifier

Derived: Gemstone.PhasorProtocols.BPAPDCstreamFrameParser
Gemstone.PhasorProtocols.FNETFrameParser
Gemstone.PhasorProtocols.IEC61850_90_5FrameParser
Gemstone.PhasorProtocols.IEEE1344FrameParser
Gemstone.PhasorProtocols.IEEEC37_118FrameParser
Gemstone.PhasorProtocols.MacrodyneFrameParser
Gemstone.PhasorProtocols.SelFastMessageFrameParser
More Less

Implements: IProvideStatus, IFrameParser, IDisposable

Type Parameters

TFrameIdentifier: Frame type identifier used to distinguish frames.

Remarks

Frame parsers are implemented as a write-only streams so that data can come from any source.
See MultiSourceFrameImageParserBase for more detail. Note that using the multi-source frame image parser base allows buffers to come in from different channels and still be parsed correctly.

Constructors

FrameParserBaseTFrameIdentifier

Creates a new FrameParserBaseTFrameIdentifier.

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)
CheckSumValidationFrameTypes	Gets or sets flags that determine if check-sums for specified frames should be validated.
ConfigurationFrame	Gets or sets current IConfigurationFrame used for parsing IDataFrame's encountered in the data stream from a device.
ConnectionParameters	Gets or sets any connection specific IConnectionParameters that may be needed for parsing.
Enabled	Gets or sets a boolean value that indicates whether the frame image parser is currently enabled. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
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. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
QueuedOutputs	Gets the total number of parsed outputs that are currently queued for publication, if any. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
ReadTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream)
RedundantFramesPerPacket	Gets the number of redundant frames in each packet.
RunTime	Gets the total amount of time, in seconds, that the BinaryImageParserBase has been active. (Inherited from BinaryImageParserBase)
Status	Gets current descriptive status of the FrameParserBaseTFrameIdentifier. (Overrides Status)
TotalProcessedBuffers	Gets the total number of buffer images processed so far. (Inherited from BinaryImageParserBase)
TrustHeaderLength	Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
ValidateCommandFrameCheckSum	Gets flag based on CheckSumValidationFrameTypes property that determines if command frames are selected for check-sum validation.
ValidateConfigurationFrameCheckSum	Gets flag based on CheckSumValidationFrameTypes property that determines if configuration frames are selected for check-sum validation.
ValidateDataFrameCheckSum	Gets flag based on CheckSumValidationFrameTypes property that determines if data frames are selected for check-sum validation.
ValidateHeaderFrameCheckSum	Gets flag based on CheckSumValidationFrameTypes property that determines if header frames are selected for check-sum validation.
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 FrameParserBaseTFrameIdentifier object and optionally releases the managed resources. (Overrides Dispose(Boolean))
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)
OnConfigurationChanged	Raises the ConfigurationChanged event.
OnDataDiscarded(Byte[])	Raises the DataDiscarded event. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
OnDataParsed(T3)	Raises the DataParsed event. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
OnDuplicateTypeHandlerEncountered(Type, T1)	Raises the DuplicateTypeHandlerEncountered event. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
OnOutputTypeNotFound(T1)	Raises the OutputTypeNotFound event. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
OnParsingException(Exception)	Raises the ParsingException event. (Inherited from BinaryImageParserBase)
OnReceivedChannelFrame	Casts the parsed IChannelFrame to its specific implementation (i.e., IDataFrame, IConfigurationFrame, ICommandFrame or IHeaderFrame).
OnReceivedCommandFrame	Raises the ReceivedCommandFrame event.
OnReceivedConfigurationFrame	Raises the ReceivedConfigurationFrame event.
OnReceivedDataFrame	Raises the ReceivedDataFrame event.
OnReceivedFrameBufferImage	Raises the ReceivedFrameImage and ReceivedFrameBufferImage event.
OnReceivedHeaderFrame	Raises the ReceivedHeaderFrame event.
OnReceivedUndeterminedFrame	Raises the ReceivedUndeterminedFrame event.
OnSourceDataParsed(T1, IList<T3>)	Raises the SourceDataParsed event. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
OnUnknownFrameTypeEncountered	Handles unknown frame types.
Parse(ISupportBinaryImage)	Not implemented. Consumers should call the Parse(T1, ISupportBinaryImage) method instead to make sure data source ID gets tracked with data buffer. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier) Obsolete.
Parse(T1, ISupportBinaryImage)	Queues the object implementing the ISupportBinaryImage interface, from the specified data source, onto the stream for parsing. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
Parse(T1, Byte[])	Queues a sequence of bytes, from the specified data source, onto the stream for parsing. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
Parse(T1, Byte[], Int32, Int32)	Queues a sequence of bytes, from the specified data source, onto the stream for parsing. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
ParseCommonHeader(Byte[], Int32, Int32)	Parses a common header instance that implements ICommonHeader for the output type represented in the binary image. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
ParseFrame(Byte[], Int32, Int32)	Output type specific frame parsing algorithm. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
PublishParsedOutput(EventArgs<T2>)	AsyncQueue handler used to publish queued outputs. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
PurgeBuffer(T1)	Clears the internal buffer of unparsed data received from the specified source. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
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. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
Start(IEnumerable<Type>)	Starts the data parser given the specified type implementations. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
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(T1, Byte[], Int32, Int32) method instead to make sure data source ID gets tracked with data buffer. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier) 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)
ConfigurationChanged	Occurs when a device sends a notification that its configuration has changed.
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 FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
DuplicateTypeHandlerEncountered	Occurs when more than one type has been defined that can deserialize the specified output type. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
OutputTypeNotFound	Occurs when matching an output type for deserializing the data image could not be found. (Inherited from FrameImageParserBaseTFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)
ParsingException	Occurs when an Exception is encountered while attempting to parse data. (Inherited from BinaryImageParserBase)
ReceivedChannelFrame	Occurs when any IChannelFrame has been received.
ReceivedCommandFrame	Occurs when a ICommandFrame has been received.
ReceivedConfigurationFrame	Occurs when a IConfigurationFrame has been received.
ReceivedDataFrame	Occurs when a IDataFrame has been received.
ReceivedFrameBufferImage	Occurs when a frame image has been received, event includes buffer.
ReceivedFrameImage	Occurs when a frame image has been received.
ReceivedHeaderFrame	Occurs when a IHeaderFrame has been received.
ReceivedUndeterminedFrame	Occurs when an undetermined IChannelFrame has been received.
SourceDataParsed	Occurs when a data image is deserialized successfully to one or more of the output types that the data image represents. (Inherited from MultiSourceFrameImageParserBaseSourceChannel, TFrameIdentifier, ISupportSourceIdentifiableFrameImageSourceChannel, TFrameIdentifier)

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)