openPDC Historian Help
PacketParser Class
NamespacesTVA.Historian.PacketsPacketParser
Represents a data parser that can parse binary data in to IPackets.
Declaration Syntax
C#Visual BasicVisual C++
public class PacketParser : MultiSourceFrameImageParserBase<Guid, short, IPacket>
Public Class PacketParser _
	Inherits MultiSourceFrameImageParserBase(Of Guid, Short, IPacket)
public ref class PacketParser : public MultiSourceFrameImageParserBase<Guid, short, IPacket^>
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
PacketParser()()()
Initializes a new instance of the PacketParser class

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.)
CreateBufferQueue()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
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.)
CurrentStatistics()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
DataDiscarded()()() (Inherited from BinaryImageParserBase.)
DataParsed()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
Dispose(Boolean) (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
Dispose()()()
Releases all resources used by the Stream.
(Inherited from Stream.)
DuplicateTypeHandlerEncountered()()() (Inherited from FrameImageParserBase<(Of <(Int16, IPacket>)>).)
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)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
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()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
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.)
OnDataDiscarded(array<Byte>[]()[]) (Inherited from BinaryImageParserBase.)
OnDataParsed(UTP, List<(Of <(UTP>)>)) (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
OnDataParsed(UTP) (Inherited from FrameImageParserBase<(Of <(Int16, IPacket>)>).)
OnDuplicateTypeHandlerEncountered(Type, UTP) (Inherited from FrameImageParserBase<(Of <(Int16, IPacket>)>).)
OnOutputTypeNotFound(UTP) (Inherited from FrameImageParserBase<(Of <(Int16, IPacket>)>).)
OnParsingException(Exception) (Inherited from BinaryImageParserBase.)
OutputTypeNotFound()()() (Inherited from FrameImageParserBase<(Of <(Int16, IPacket>)>).)
Parse(UTP, array<Byte>[]()[]) (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
Parse(UTP, array<Byte>[]()[], Int32, Int32) (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
Parse(UTP, ISupportBinaryImage) (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
Parse(ISupportBinaryImage) Obsolete. (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
ParseCommonHeader(array<Byte>[]()[], Int32, Int32)
Returns an PacketCommonHeader object.
(Overrides FrameImageParserBase<(Of <(Int16, IPacket>)>).ParseCommonHeader(array<Byte>[]()[], Int32, Int32).)
ParseFrame(array<Byte>[]()[], Int32, Int32) (Inherited from FrameImageParserBase<(Of <(Int16, IPacket>)>).)
ParseQueuedBuffers(array<IdentifiableItem<(Of <(UTP, array<Byte>[]()[]>)>)>[]()[]) (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
ParsingException()()() (Inherited from BinaryImageParserBase.)
Position()()() (Inherited from BinaryImageParserBase.)
ProtocolSyncBytes()()() (Inherited from BinaryImageParserBase.)
ProtocolUsesSyncBytes
Returns false since the protocol implementation of IPacket does not use synchronization.
(Overrides BinaryImageParserBase.ProtocolUsesSyncBytes()()().)
PurgeBuffer(UTP) (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
QueuedBuffers()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
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.)
RunTime()()() (Inherited from BinaryImageParserBase.)
Seek(Int64, SeekOrigin) (Inherited from BinaryImageParserBase.)
SetLength(Int64) (Inherited from BinaryImageParserBase.)
Start()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
Start(IEnumerable<(Of <(Type>)>)) (Inherited from FrameImageParserBase<(Of <(Int16, IPacket>)>).)
Status()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
Stop()()() (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
StreamInitialized()()() (Inherited from BinaryImageParserBase.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
TotalProcessedBuffers()()() (Inherited from BinaryImageParserBase.)
UnparsedBuffer()()() (Inherited from BinaryImageParserBase.)
Write(array<Byte>[]()[], Int32, Int32) Obsolete. (Inherited from MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>).)
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.)
Inheritance Hierarchy
Object
MarshalByRefObject
 Stream
  BinaryImageParserBase
   FrameImageParserBase<(Of <(Int16, IPacket>)>)
    MultiSourceFrameImageParserBase<(Of <(Guid, Int16, IPacket>)>)
     PacketParser

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.33.39252