Represents a frame parser for a F-NET text based data stream that returns parsed data via events.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public class FrameParser : FrameParserBase<int>
Public Class FrameParser _ Inherits FrameParserBase(Of Integer)
public ref class FrameParser : public FrameParserBase<int>
Members
All Members | Constructors | Methods | Properties | Fields | Events |
Icon | Member | Description |
---|---|---|
FrameParser()()()() |
Creates a new FrameParser.
| |
FrameParser(UInt16, LineFrequency, Ticks, String) |
Creates a new FrameParser from specified parameters.
| |
BeginRead(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) | HostProtectionAttribute.
Begins an asynchronous read operation.
(Inherited from Stream.) | |
BeginWrite(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) | HostProtectionAttribute.
Begins an asynchronous write operation.
(Inherited from Stream.) | |
CanRead()()()() | (Inherited from BinaryImageParserBase.) | |
CanSeek()()()() | (Inherited from BinaryImageParserBase.) | |
CanTimeout |
Gets a value that determines whether the current stream can time out.
(Inherited from Stream.) | |
CanWrite()()()() | (Inherited from BinaryImageParserBase.) | |
Close()()()() |
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
(Inherited from Stream.) | |
ConfigurationChanged |
Occurs when a device sends a notification that its configuration has changed.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
ConfigurationFrame |
Gets or sets current IConfigurationFrame used for parsing IDataFrame's encountered in the data stream from a device.
(Overrides FrameParserBase<(Of <(<'Int32>)>)>.ConfigurationFrame.) | |
ConnectionParameters |
Gets or sets any connection specific IConnectionParameters that may be needed for parsing.
(Overrides FrameParserBase<(Of <(<'Int32>)>)>.ConnectionParameters.) | |
CreateBufferQueue()()()() |
Creates the internal buffer queue.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
CreateObjRef(Type) |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.) | |
CreateWaitHandle()()()() | Obsolete.
Allocates a WaitHandle object.
(Inherited from Stream.) | |
DataDiscarded()()()() | (Inherited from BinaryImageParserBase.) | |
DataParsed()()()() | (Inherited from FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.) | |
Dispose(Boolean) |
Releases the unmanaged resources used by the FrameParserBase<(Of <(<'TFrameIdentifier>)>)> object and optionally releases the managed resources.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
Dispose()()()() |
Releases all resources used by the Stream.
(Inherited from Stream.) | |
DuplicateTypeHandlerEncountered()()()() | (Inherited from FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.) | |
Enabled()()()() | (Inherited from BinaryImageParserBase.) | |
EndRead(IAsyncResult) |
Waits for the pending asynchronous read to complete.
(Inherited from Stream.) | |
EndWrite(IAsyncResult) |
Ends an asynchronous write operation.
(Inherited from Stream.) | |
Equals(Object) | (Inherited from Object.) | |
ExecuteParseOnSeparateThread |
Gets or sets a flag that allows frame parsing to be executed on a separate thread (i.e., other than communications thread).
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
Flush()()()() |
Clears all buffers for this stream and causes any buffered data to be parsed immediately.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
FrameRate |
Gets or sets the configured frame rate for the F-NET device.
| |
GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetLifetimeService()()()() |
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.) | |
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.) | |
Length()()()() | (Inherited from BinaryImageParserBase.) | |
MemberwiseClone(Boolean) |
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.) | |
MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
Name()()()() | (Inherited from BinaryImageParserBase.) | |
NominalFrequency |
Gets or sets the nominal LineFrequency of the F-NET device.
| |
OnConfigurationChanged()()()() |
Raises the ConfigurationChanged event.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OnDataDiscarded(array<Byte>[]()[][]) | (Inherited from BinaryImageParserBase.) | |
OnDataParsed(UTP) | (Inherited from FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.) | |
OnDuplicateTypeHandlerEncountered(Type, UTP) | (Inherited from FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.) | |
OnOutputTypeNotFound(UTP) | (Inherited from FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.) | |
OnParsingException(Exception) | (Inherited from BinaryImageParserBase.) | |
OnReceivedChannelFrame(IChannelFrame) |
Casts the parsed IChannelFrame to its specific implementation (i.e., DataFrame or ConfigurationFrame).
(Overrides FrameParserBase<(Of <(<'Int32>)>)>.OnReceivedChannelFrame(IChannelFrame).) | |
OnReceivedCommandFrame(ICommandFrame) |
Raises the ReceivedCommandFrame event.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OnReceivedConfigurationFrame(IConfigurationFrame) |
Raises the ReceivedConfigurationFrame event.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OnReceivedDataFrame(IDataFrame) |
Raises the ReceivedDataFrame event.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OnReceivedFrameBufferImage(FundamentalFrameType, array<Byte>[]()[][], Int32, Int32) |
Raises the ReceivedFrameBufferImage event.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OnReceivedHeaderFrame(IHeaderFrame) |
Raises the ReceivedHeaderFrame event.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OnReceivedUndeterminedFrame(IChannelFrame) |
Raises the ReceivedUndeterminedFrame event.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OnUnknownFrameTypeEncountered(TFrameIdentifier) |
Handles unknown frame types.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
OutputTypeNotFound()()()() | (Inherited from FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.) | |
Parse(ISupportBinaryImage) | (Inherited from BinaryImageParserBase.) | |
ParseCommonHeader(array<Byte>[]()[][], Int32, Int32) |
Parses a common header instance that implements ICommonHeader for the output type represented
in the binary image.
(Overrides FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.ParseCommonHeader(array<Byte>[]()[][], Int32, Int32).) | |
ParseFrame(array<Byte>[]()[][], Int32, Int32) | (Inherited from FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.) | |
ParseQueuedBuffers(array<array<Byte>[]()[][]>[]()[][]) |
This method is used by the internal ProcessQueue to process all queued data buffers.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
ParsingException()()()() | (Inherited from BinaryImageParserBase.) | |
Position()()()() | (Inherited from BinaryImageParserBase.) | |
ProtocolSyncBytes()()()() | (Inherited from BinaryImageParserBase.) | |
ProtocolUsesSyncBytes |
Gets flag that determines if F-NET protocol parsing implementation uses synchronization bytes.
(Overrides BinaryImageParserBase.ProtocolUsesSyncBytes()()()().) | |
QueuedBuffers |
Gets the total number of buffers that are currently queued for processing, if any.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
Read(array<Byte>[]()[][], Int32, Int32) | (Inherited from BinaryImageParserBase.) | |
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.) | |
ReadTimeout |
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream.) | |
ReceivedCommandFrame |
Occurs when a ICommandFrame has been received.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
ReceivedConfigurationFrame |
Occurs when a F-NET ConfigurationFrame has been received.
| |
ReceivedDataFrame |
Occurs when a F-NET DataFrame has been received.
| |
ReceivedFrameBufferImage |
Occurs when a frame buffer image has been received.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
ReceivedHeaderFrame |
Occurs when a IHeaderFrame has been received.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
ReceivedUndeterminedFrame |
Occurs when an undetermined IChannelFrame has been received.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
RunTime()()()() | (Inherited from BinaryImageParserBase.) | |
Seek(Int64, SeekOrigin) | (Inherited from BinaryImageParserBase.) | |
SetLength(Int64) | (Inherited from BinaryImageParserBase.) | |
Start()()()() |
Start the data parser.
(Overrides FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)>.Start()()()().) | |
Start(IEnumerable<(Of <<'(Type>)>>)) |
Starts the frame parser given the specified type implementations.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
StationName |
Gets or sets the station name for the F-NET device.
| |
Status |
Gets current descriptive status of the FrameParser.
(Overrides FrameParserBase<(Of <(<'Int32>)>)>.Status.) | |
Stop()()()() |
Stops the frame parser.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
StreamInitialized()()()() | (Inherited from BinaryImageParserBase.) | |
TimeOffset |
Gets or sets time offset of F-NET device in Ticks.
| |
ToString()()()() | (Inherited from Object.) | |
TotalProcessedBuffers()()()() | (Inherited from BinaryImageParserBase.) | |
UnparsedBuffer()()()() | (Inherited from BinaryImageParserBase.) | |
Write(array<Byte>[]()[][], Int32, Int32) |
Writes a sequence of bytes onto the stream for parsing.
(Inherited from FrameParserBase<(Of <(<'TFrameIdentifier>)>)>.) | |
WriteByte(Byte) |
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream.) | |
WriteTimeout |
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream.) |
Remarks
Frame parser is implemented as a write-only stream - this way data can come from any source.
Inheritance Hierarchy
Object | ||||||
MarshalByRefObject | ||||||
Stream | ||||||
BinaryImageParserBase | ||||||
FrameImageParserBase<(Of <(<'Int32, ISupportFrameImage<(Of <(<'Int32>)>)>>)>)> | ||||||
FrameParserBase<(Of <(<'Int32>)>)> | ||||||
FrameParser |