Represents a protocol independent representation of a frame parser.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface IFrameParser : IProvideStatus, IDisposable
Public Interface IFrameParser _ Inherits IProvideStatus, IDisposable
public interface class IFrameParser : IProvideStatus, IDisposable
Members| All Members | Methods | Properties | Events | ||
| Icon | Member | Description |
|---|---|---|
 | ConfigurationChanged |
Occurs when a device sends a notification that its configuration has changed.
|
 | 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.
|
 | Dispose()()()() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.) |
| Enabled |
Gets or sets a boolean value that indicates whether the data parser is currently enabled.
|
| ExecuteParseOnSeparateThread |
Gets or sets a flag that allows frame parsing to be executed on a separate thread (i.e., other than communications thread).
|
| Name()()()() | (Inherited from IProvideStatus.) |
| ParsingException |
Occurs when an Exception is encountered while attempting to parse data.
|
| QueuedBuffers |
Gets the total number of buffers that are currently queued for processing, if any.
|
| 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.
|
| ReceivedHeaderFrame |
Occurs when a IHeaderFrame has been received.
|
| ReceivedUndeterminedFrame |
Occurs when an undetermined IChannelFrame has been received.
|
| Start()()()() |
Start the streaming data parser.
|
| Status()()()() | (Inherited from IProvideStatus.) |
| Stop()()()() |
Stops the streaming data parser.
|
| Write(array<Byte>[]()[][], Int32, Int32) |
Writes a sequence of bytes onto the IBinaryImageParser stream for parsing.
|
Remarks
This interface allows protocol specific frame parsers to be handled abstractly by the MultiProtocolFrameParser.