|
IFrame
|
Represents a protocol independent representation of a frame parser.
Namespace: GSF.PhasorProtocols
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.218-beta
Syntaxpublic interface IFrameParser : IProvideStatus, IDisposable
The IFrameParser type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | 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 data parser is currently enabled. |
| Name |
Gets the name of the object providing status information.
(Inherited from IProvideStatus) |
| QueuedBuffers | Gets the total number of buffers that are currently queued for processing, if any. |
| QueuedOutputs | Gets the total number of frames that are currently queued for publication, if any. |
| RedundantFramesPerPacket | Gets the number of redundant frames in each packet. |
| Status |
Gets the current status details about object providing status information.
(Inherited from IProvideStatus) |
| TrustHeaderLength | Gets or sets flag that determines if header lengths should be trusted over parsed byte count. |
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Parse | Writes a sequence of bytes onto the IBinaryImageParser stream for parsing. |
| Start | Start the streaming data parser. |
| Stop | Stops the streaming data parser. |
Events| Name | Description | |
|---|---|---|
 | BufferParsed | Occurs when buffer parsing has completed. |
| ConfigurationChanged | Occurs when a device sends a notification that its configuration has changed. |
| ParsingException | Occurs when an Exception is encountered while attempting to parse data. |
| 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 buffer image has been received. |
| 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. |
Remarks
This interface allows protocol specific frame parsers to be handled abstractly by the MultiProtocolFrameParser.
See Also