Click or drag to resize

FrameParser Class

Represents a frame parser for an IEEE 1344 binary data stream that returns parsed data via events.
Inheritance Hierarchy

Namespace: GSF.PhasorProtocols.IEEE1344
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.181-beta
Syntax
public class FrameParser : FrameParserBase<FrameType>
View Source

The FrameParser type exposes the following members.

Constructors
 NameDescription
Public methodFrameParser Creates a new FrameParser.
Top
Properties
 NameDescription
Public propertyCanRead Gets a value indicating whether the current stream supports reading.
(Inherited from BinaryImageParserBase)
Public propertyCanSeek Gets a value indicating whether the current stream supports seeking.
(Inherited from BinaryImageParserBase)
Public propertyCanTimeoutGets a value that determines whether the current stream can time out.
(Inherited from Stream)
Public propertyCanWrite Gets a value indicating whether the current stream supports writing.
(Inherited from BinaryImageParserBase)
Public propertyCheckSumValidationFrameTypes Gets or sets flags that determine if check-sums for specified frames should be validated.
(Inherited from FrameParserBaseTFrameIdentifier)
Public propertyConfigurationFrame Gets or sets current IConfigurationFrame used for parsing IDataFrame's encountered in the data stream from a device.
(Overrides FrameParserBaseTFrameIdentifierConfigurationFrame)
Public propertyConnectionParameters Gets or sets any connection specific IConnectionParameters that may be needed for parsing.
(Inherited from FrameParserBaseTFrameIdentifier)
Public propertyEnabled Gets or sets a boolean value that indicates whether the frame image parser is currently enabled.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Public propertyLength The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public propertyName Gets the name of BinaryImageParserBase.
(Inherited from BinaryImageParserBase)
Public propertyPosition The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public propertyProtocolSyncBytes Gets or sets synchronization bytes for this parsing implementation, if used.
(Inherited from BinaryImageParserBase)
Public propertyProtocolUsesSyncBytes Gets flag that determines if this protocol parsing implementation uses synchronization bytes.
(Overrides BinaryImageParserBaseProtocolUsesSyncBytes)
Public propertyQueuedBuffers Gets the total number of buffers that are currently queued for processing, if any.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public propertyQueuedOutputs Gets the total number of parsed outputs that are currently queued for publication, if any.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Public propertyReadTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream)
Public propertyRedundantFramesPerPacket Gets the number of redundant frames in each packet.
(Inherited from FrameParserBaseTFrameIdentifier)
Public propertyRunTime Gets the total amount of time, in seconds, that the BinaryImageParserBase has been active.
(Inherited from BinaryImageParserBase)
Public propertyStatus Gets current descriptive status of the FrameParserBaseTFrameIdentifier.
(Inherited from FrameParserBaseTFrameIdentifier)
Public propertyTotalProcessedBuffers Gets the total number of buffer images processed so far.
(Inherited from BinaryImageParserBase)
Public propertyTrustHeaderLength Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected propertyValidateCommandFrameCheckSum Gets flag based on CheckSumValidationFrameTypes property that determines if command frames are selected for check-sum validation.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected propertyValidateConfigurationFrameCheckSum Gets flag based on CheckSumValidationFrameTypes property that determines if configuration frames are selected for check-sum validation.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected propertyValidateDataFrameCheckSum Gets flag based on CheckSumValidationFrameTypes property that determines if data frames are selected for check-sum validation.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected propertyValidateHeaderFrameCheckSum Gets flag based on CheckSumValidationFrameTypes property that determines if header frames are selected for check-sum validation.
(Inherited from FrameParserBaseTFrameIdentifier)
Public propertyWriteTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream)
Top
Methods
 NameDescription
Public methodBeginReadBegins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodBeginWriteBegins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodCloseCloses 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)
Public methodCopyTo(Stream)Reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream)
Public methodCopyTo(Stream, Int32)Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream)
Public methodCopyToAsync(Stream)Asynchronously reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream)
Public methodCopyToAsync(Stream, Int32)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream)
Public methodCopyToAsync(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.
(Inherited from Stream)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Protected methodCreateWaitHandleObsolete.
Allocates a WaitHandle object.
(Inherited from Stream)
Public methodDisposeReleases all resources used by the Stream.
(Inherited from Stream)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the FrameParserBaseTFrameIdentifier object and optionally releases the managed resources.
(Inherited from FrameParserBaseTFrameIdentifier)
Public methodEndReadWaits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodEndWriteEnds an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFlush 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)
Public methodFlushAsyncAsynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from Stream)
Public methodFlushAsync(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)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected methodObjectInvariantObsolete.
Provides support for a Contract.
(Inherited from Stream)
Protected methodOnBufferParsed Raises the BufferParsed event.
(Inherited from BinaryImageParserBase)
Protected methodOnConfigurationChanged Raises the ConfigurationChanged event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected methodOnDataDiscarded Raises the DataDiscarded event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected methodOnDataParsed Raises the DataParsed event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected methodOnDuplicateTypeHandlerEncountered Raises the DuplicateTypeHandlerEncountered event.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Protected methodOnOutputTypeNotFound Raises the OutputTypeNotFound event.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Protected methodOnParsingException Raises the ParsingException event.
(Inherited from BinaryImageParserBase)
Protected methodOnReceivedChannelFrame Casts the parsed IChannelFrame to its specific implementation (i.e., DataFrame, ConfigurationFrame, CommandFrame or HeaderFrame).
(Overrides FrameParserBaseTFrameIdentifierOnReceivedChannelFrame(IChannelFrame))
Protected methodOnReceivedCommandFrame Raises the ReceivedCommandFrame event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected methodOnReceivedConfigurationFrame Raises the ReceivedConfigurationFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedConfigurationFrame(IConfigurationFrame))
Protected methodOnReceivedDataFrame Raises the ReceivedDataFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedDataFrame(IDataFrame))
Protected methodOnReceivedFrameBufferImage Raises the ReceivedFrameImage and ReceivedFrameBufferImage event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected methodOnReceivedHeaderFrame Raises the ReceivedHeaderFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedHeaderFrame(IHeaderFrame))
Protected methodOnReceivedUndeterminedFrame Raises the ReceivedUndeterminedFrame event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected methodOnSourceDataParsed Raises the SourceDataParsed event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected methodOnUnknownFrameTypeEncountered Handles unknown frame types.
(Inherited from FrameParserBaseTFrameIdentifier)
Public methodParse(ISupportBinaryImage)Obsolete.
Not implemented. Consumers should call the Parse(TSourceIdentifier, ISupportBinaryImage) method instead to make sure data source source ID gets tracked with data buffer.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public methodParse(TSourceIdentifier, ISupportBinaryImage) Queues the object implementing the ISupportBinaryImage interface, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public methodParse(TSourceIdentifier, Byte) Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public methodParse(TSourceIdentifier, Byte, Int32, Int32) Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected methodParseCommonHeader Parses a common header instance that implements ICommonHeaderTTypeIdentifier for the output type represented in the binary image.
(Overrides FrameImageParserBaseTTypeIdentifier, TOutputTypeParseCommonHeader(Byte, Int32, Int32))
Protected methodParseFrame Output type specific frame parsing algorithm.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Protected methodPublishParsedOutputAsyncQueueT handler used to publish queued outputs.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Public methodPurgeBuffer Clears the internal buffer of unparsed data received from the specified source.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public methodRead The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public methodReadAsync(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)
Public methodReadAsync(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)
Public methodReadByteReads 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)
Public methodSeek The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public methodSetLength The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public methodStart Start the data parser.
(Overrides MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputTypeStart)
Public methodStart(IEnumerableType) Starts the data parser given the specified type implementations.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public methodStop Stops the streaming data parser.
(Inherited from BinaryImageParserBase)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWriteObsolete.
Not implemented. Consumers should call the Parse(TSourceIdentifier, Byte, Int32, Int32) method instead to make sure data source source ID gets tracked with data buffer.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public methodWriteAsync(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)
Public methodWriteAsync(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)
Public methodWriteByteWrites a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream)
Top
Events
 NameDescription
Public eventBufferParsed Occurs when buffer parsing has completed.
(Inherited from BinaryImageParserBase)
Public eventConfigurationChanged Occurs when a device sends a notification that its configuration has changed.
(Inherited from FrameParserBaseTFrameIdentifier)
Public eventDataDiscarded Occurs when data image fails deserialized due to an exception.
(Inherited from BinaryImageParserBase)
Public eventDataParsed Occurs when a data image is deserialized successfully to one of the output types that the data image represents.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Public eventDuplicateTypeHandlerEncountered Occurs when more than one type has been defined that can deserialize the specified output type.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Public eventOutputTypeNotFound Occurs when matching an output type for deserializing the data image could not be found.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Public eventParsingException Occurs when an Exception is encountered while attempting to parse data.
(Inherited from BinaryImageParserBase)
Public eventReceivedChannelFrame Occurs when any IChannelFrame has been received.
(Inherited from FrameParserBaseTFrameIdentifier)
Public eventReceivedCommandFrame Occurs when an IEEE 1344 CommandFrame has been received.
Public eventReceivedConfigurationFrame Occurs when an IEEE 1344 ConfigurationFrame has been received.
Public eventReceivedDataFrame Occurs when an IEEE 1344 DataFrame has been received.
Public eventReceivedFrameBufferImage Occurs when a frame image has been received, event includes buffer.
(Inherited from FrameParserBaseTFrameIdentifier)
Public eventReceivedFrameImage Occurs when a frame image has been received.
(Inherited from FrameParserBaseTFrameIdentifier)
Public eventReceivedHeaderFrame Occurs when an IEEE 1344 HeaderFrame has been received.
Public eventReceivedUndeterminedFrame Occurs when an undetermined IChannelFrame has been received.
(Inherited from FrameParserBaseTFrameIdentifier)
Public eventSourceDataParsed Occurs when a data image is deserialized successfully to one or more of the output types that the data image represents.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Top
Fields
 NameDescription
Protected fieldStreamInitialized Tracks if data stream has been initialized.
(Inherited from BinaryImageParserBase)
Protected fieldUnparsedBuffer Remaining unparsed buffer from last parsing execution, if any.
(Inherited from BinaryImageParserBase)
Top
Extension Methods
 NameDescription
Public Extension MethodCompress Compress a stream using specified compression strength.
(Defined by CompressionExtensions)
Public Extension MethodCompress Compress a stream onto given output stream using specified compression strength.
(Defined by CompressionExtensions)
Public Extension MethodCopyStream Copies input Stream onto output Stream.
(Defined by StreamExtensions)
Public Extension MethodCopyTo Writes the contents of a stream to the provided stream.
(Defined by StreamExtensions)
Public Extension MethodDecompress Decompress a stream.
(Defined by CompressionExtensions)
Public Extension MethodDecompress Decompress a stream onto given output stream.
(Defined by CompressionExtensions)
Public Extension MethodDecrypt Returns a stream of decrypted data for the given parameters.
(Defined by Cipher)
Public Extension MethodDecrypt Decrypts input stream onto output stream for the given parameters.
(Defined by Cipher)
Public Extension MethodDeserializeToDataSet Deserializes a DataSet from a Stream.
(Defined by DataSetExtensions)
Public Extension MethodEncrypt Returns a stream of encrypted data for the given parameters.
(Defined by Cipher)
Public Extension MethodEncrypt Encrypts input stream onto output stream for the given parameters.
(Defined by Cipher)
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodRead7BitUInt32 Reads the 7-bit encoded value from the stream.
(Defined by StreamExtensions)
Public Extension MethodReadAll 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)
Public Extension MethodReadBoolean Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
Public Extension MethodReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
Public Extension MethodReadChar Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadDateTime Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadDecimal Reads a decimal from the stream in Little Endian bytes.
(Defined by StreamExtensions)
Public Extension MethodReadDouble Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadGuid Reads a Guid from the stream in Little Endian bytes.
(Defined by StreamExtensions)
Public Extension MethodReadInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadInt32Collection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodReadInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadNextByte Read a byte from the stream. Will throw an exception if the end of the stream has been reached.
(Defined by StreamExtensions)
Public Extension MethodReadNullableString Reads a string from a Stream that was encoded in UTF8. Value can be null and is prefixed with a boolean.
(Defined by StreamExtensions)
Public Extension MethodReadObject Reads an object from a stream.
(Defined by StreamExtensions)
Public Extension MethodReadSByte Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadSingle Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadStream Reads entire Stream contents, and returns Byte array of data.
(Defined by StreamExtensions)
Public Extension MethodReadString Reads a string from a Stream that was encoded in UTF8.
(Defined by StreamExtensions)
Public Extension MethodReadStringCollection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodReadUInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadUInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadUInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the entire buffer to the stream
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes a guid in little endian bytes to the stream
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
Public Extension MethodWriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
Public Extension MethodWriteNullable Writes the supplied string to a Stream in UTF8 encoding with a prefix if the value is null
(Defined by StreamExtensions)
Public Extension MethodWriteObject Encodes an object on a stream.
(Defined by StreamExtensions)
Public Extension MethodWriteWithLength Writes the supplied value to stream along with prefixing the length so it can be properly read as a unit.
(Defined by StreamExtensions)
Top
Remarks
Frame parser is implemented as a write-only stream - this way data can come from any source.
See Also