Click or drag to resize

IFrameParser Interface

Represents a protocol independent representation of a frame parser.

Namespace: GSF.PhasorProtocols
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.207-beta
Syntax
public interface IFrameParser : IProvideStatus, 
	IDisposable
View Source

The IFrameParser type exposes the following members.

Properties
 NameDescription
Public propertyCheckSumValidationFrameTypes Gets or sets flags that determine if check-sums for specified frames should be validated.
Public propertyConfigurationFrame Gets or sets current IConfigurationFrame used for parsing IDataFrame's encountered in the data stream from a device.
Public propertyConnectionParameters Gets or sets any connection specific IConnectionParameters that may be needed for parsing.
Public propertyEnabled Gets or sets a boolean value that indicates whether the data parser is currently enabled.
Public propertyName Gets the name of the object providing status information.
(Inherited from IProvideStatus)
Public propertyQueuedBuffers Gets the total number of buffers that are currently queued for processing, if any.
Public propertyQueuedOutputs Gets the total number of frames that are currently queued for publication, if any.
Public propertyRedundantFramesPerPacket Gets the number of redundant frames in each packet.
Public propertyStatus Gets the current status details about object providing status information.
(Inherited from IProvideStatus)
Public propertyTrustHeaderLength Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
Top
Methods
 NameDescription
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodParse Writes a sequence of bytes onto the IBinaryImageParser stream for parsing.
Public methodStart Start the streaming data parser.
Public methodStop Stops the streaming data parser.
Top
Events
 NameDescription
Public eventBufferParsed Occurs when buffer parsing has completed.
Public eventConfigurationChanged Occurs when a device sends a notification that its configuration has changed.
Public eventParsingException Occurs when an Exception is encountered while attempting to parse data.
Public eventReceivedChannelFrame Occurs when any IChannelFrame has been received.
Public eventReceivedCommandFrame Occurs when a ICommandFrame has been received.
Public eventReceivedConfigurationFrame Occurs when a IConfigurationFrame has been received.
Public eventReceivedDataFrame Occurs when a IDataFrame has been received.
Public eventReceivedFrameBufferImage Occurs when a frame buffer image has been received.
Public eventReceivedFrameImage Occurs when a frame image has been received.
Public eventReceivedHeaderFrame Occurs when a IHeaderFrame has been received.
Public eventReceivedUndeterminedFrame Occurs when an undetermined IChannelFrame has been received.
Top
Remarks
This interface allows protocol specific frame parsers to be handled abstractly by the MultiProtocolFrameParser.
See Also