|
Packet
|
Represents a data parser that can parse binary data in to IPackets.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
System.IOStream
GSF.ParsingBinaryImageParserBase
GSF.ParsingFrameImageParserBaseInt16, IPacket
GSF.ParsingMultiSourceFrameImageParserBaseGuid, Int16, IPacket
GSF.Historian.PacketsPacketParser
SystemMarshalByRefObject
System.IOStream
GSF.ParsingBinaryImageParserBase
GSF.ParsingFrameImageParserBaseInt16, IPacket
GSF.ParsingMultiSourceFrameImageParserBaseGuid, Int16, IPacket
GSF.Historian.PacketsPacketParser
Namespace: GSF.Historian.Packets
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.218-beta
Syntaxpublic class PacketParser : MultiSourceFrameImageParserBase<Guid, short, IPacket>
The PacketParser type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PacketParser | Initializes a new instance of the PacketParser class |
Properties| Name | Description | |
|---|---|---|
 | CanRead |
Gets a value indicating whether the current stream supports reading.
(Inherited from BinaryImageParserBase) |
| CanSeek |
Gets a value indicating whether the current stream supports seeking.
(Inherited from BinaryImageParserBase) |
| CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream) |
| CanWrite |
Gets a value indicating whether the current stream supports writing.
(Inherited from BinaryImageParserBase) |
| Enabled |
Gets or sets a boolean value that indicates whether the frame image parser is currently enabled.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| Length |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| Name |
Gets the name of BinaryImageParserBase.
(Inherited from BinaryImageParserBase) |
| Position |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| ProtocolSyncBytes |
Gets or sets synchronization bytes for this parsing implementation, if used.
(Inherited from BinaryImageParserBase) |
| ProtocolUsesSyncBytes |
Returns false since the protocol implementation of IPacket does not use synchronization.
(Overrides BinaryImageParserBaseProtocolUsesSyncBytes) |
| QueuedBuffers |
Gets the total number of buffers that are currently queued for processing, if any.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| QueuedOutputs |
Gets the total number of parsed outputs that are currently queued for publication, if any.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| 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 |
Gets the total amount of time, in seconds, that the BinaryImageParserBase has been active.
(Inherited from BinaryImageParserBase) |
| Status |
Gets current status of FrameImageParserBaseTTypeIdentifier, TOutputType.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| TotalProcessedBuffers |
Gets the total number of buffer images processed so far.
(Inherited from BinaryImageParserBase) |
| WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream) |
Methods| Name | Description | |
|---|---|---|
| BeginRead | Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| BeginWrite | Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| Close | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Inherited from Stream) |
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream) |
| CopyTo(Stream, Int32) | Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream) |
| CopyToAsync(Stream) | Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream) |
| CopyToAsync(Stream, Int32) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream) |
| CopyToAsync(Stream, Int32, CancellationToken) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Inherited from Stream) |
| CreateObjRef | 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) |
| Dispose | Releases all resources used by the Stream. (Inherited from Stream) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the FrameImageParserBaseTTypeIdentifier, TOutputType object and optionally releases the managed resources.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| EndRead | Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| EndWrite | Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Flush |
When overridden in a derived class, clears all buffers for this stream and causes any buffered data
to be written to the underlying device.
(Inherited from BinaryImageParserBase) |
| FlushAsync | Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream) |
| FlushAsync(CancellationToken) | Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. (Inherited from Stream) |
| GetHashCode | Serves as the default hash function. (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) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| ObjectInvariant | Obsolete. Provides support for a Contract. (Inherited from Stream) |
| OnBufferParsed |
Raises the BufferParsed event.
(Inherited from BinaryImageParserBase) |
| OnDataDiscarded |
Raises the DataDiscarded event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| OnDataParsed |
Raises the DataParsed event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| OnDuplicateTypeHandlerEncountered |
Raises the DuplicateTypeHandlerEncountered event.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| OnOutputTypeNotFound |
Raises the OutputTypeNotFound event.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| OnParsingException |
Raises the ParsingException event.
(Inherited from BinaryImageParserBase) |
| OnSourceDataParsed |
Raises the SourceDataParsed event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| Parse(ISupportBinaryImage) | Obsolete. Not implemented. Consumers should call the Parse(TSourceIdentifier, ISupportBinaryImage) method instead to make sure data source source ID gets tracked with data buffer. (Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| Parse(TSourceIdentifier, ISupportBinaryImage) |
Queues the object implementing the ISupportBinaryImage interface, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| Parse(TSourceIdentifier, Byte) |
Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| Parse(TSourceIdentifier, Byte, Int32, Int32) |
Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| ParseCommonHeader |
Returns an PacketCommonHeader object.
(Overrides FrameImageParserBaseTTypeIdentifier, TOutputTypeParseCommonHeader(Byte, Int32, Int32)) |
| ParseFrame |
Output type specific frame parsing algorithm.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| PublishParsedOutput | AsyncQueueT handler used to publish queued outputs.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| PurgeBuffer |
Clears the internal buffer of unparsed data received from the specified source.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| Read |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| ReadAsync(Byte, Int32, Int32) | Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream) |
| ReadAsync(Byte, Int32, Int32, CancellationToken) | Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream) |
| 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) |
| Seek |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| SetLength |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| Start |
Start the streaming data parser.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| Start(IEnumerableType) |
Starts the data parser given the specified type implementations.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| Stop |
Stops the streaming data parser.
(Inherited from BinaryImageParserBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Write | Obsolete. Not implemented. Consumers should call the Parse(TSourceIdentifier, Byte, Int32, Int32) method instead to make sure data source source ID gets tracked with data buffer. (Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
| WriteAsync(Byte, Int32, Int32) | Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream) |
| WriteAsync(Byte, Int32, Int32, CancellationToken) | Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from Stream) |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream) |
Events| Name | Description | |
|---|---|---|
 | BufferParsed |
Occurs when buffer parsing has completed.
(Inherited from BinaryImageParserBase) |
| DataDiscarded |
Occurs when data image fails deserialized due to an exception.
(Inherited from BinaryImageParserBase) |
| DataParsed |
Occurs when a data image is deserialized successfully to one of the output types that the data
image represents.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| DuplicateTypeHandlerEncountered |
Occurs when more than one type has been defined that can deserialize the specified output type.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| OutputTypeNotFound |
Occurs when matching an output type for deserializing the data image could not be found.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType) |
| ParsingException |
Occurs when an Exception is encountered while attempting to parse data.
(Inherited from BinaryImageParserBase) |
| SourceDataParsed |
Occurs when a data image is deserialized successfully to one or more of the output types that the data image represents.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType) |
Fields| Name | Description | |
|---|---|---|
 | StreamInitialized |
Tracks if data stream has been initialized.
(Inherited from BinaryImageParserBase) |
| UnparsedBuffer |
Remaining unparsed buffer from last parsing execution, if any.
(Inherited from BinaryImageParserBase) |
Extension Methods| Name | Description | |
|---|---|---|
 | Compress |
Compress a stream using specified compression strength.
(Defined by CompressionExtensions) |
| Compress |
Compress a stream onto given output stream using specified compression strength.
(Defined by CompressionExtensions) |
| CopyStream |
Copies input Stream onto output Stream.
(Defined by StreamExtensions) |
| CopyTo |
Writes the contents of a stream to the provided stream.
(Defined by StreamExtensions) |
| Decompress |
Decompress a stream.
(Defined by CompressionExtensions) |
| Decompress |
Decompress a stream onto given output stream.
(Defined by CompressionExtensions) |
| Decrypt |
Returns a stream of decrypted data for the given parameters.
(Defined by Cipher) |
| Decrypt |
Decrypts input stream onto output stream for the given parameters.
(Defined by Cipher) |
| DeserializeToDataSet |
Deserializes a DataSet from a Stream.
(Defined by DataSetExtensions) |
| Encrypt |
Returns a stream of encrypted data for the given parameters.
(Defined by Cipher) |
| Encrypt |
Encrypts input stream onto output stream for the given parameters.
(Defined by Cipher) |
| GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| Read7BitUInt32 |
Reads the 7-bit encoded value from the stream.
(Defined by StreamExtensions) |
| ReadAll |
Reads all of the provided bytes. Will not return prematurely,
but continue to execute a Read(Byte, Int32, Int32) command until the entire
length has been read.
(Defined by StreamExtensions) |
| ReadBoolean |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadBytes |
Reads a byte array from a Stream.
The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions) |
| ReadBytes |
Reads a byte array from a Stream.
The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions) |
| ReadChar |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadDateTime |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadDecimal |
Reads a decimal from the stream in Little Endian bytes.
(Defined by StreamExtensions) |
| ReadDouble |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadGuid |
Reads a Guid from the stream in Little Endian bytes.
(Defined by StreamExtensions) |
| ReadInt16 |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadInt32 |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadInt32Collection |
Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions) |
| ReadInt64 |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadNextByte |
Read a byte from the stream.
Will throw an exception if the end of the stream has been reached.
(Defined by StreamExtensions) |
| ReadNullableString |
Reads a string from a Stream that was encoded in UTF8.
Value can be null and is prefixed with a boolean.
(Defined by StreamExtensions) |
| ReadObject |
Reads an object from a stream.
(Defined by StreamExtensions) |
| ReadSByte |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadSingle |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadStream |
Reads entire Stream contents, and returns Byte array of data.
(Defined by StreamExtensions) |
| ReadString |
Reads a string from a Stream that was encoded in UTF8.
(Defined by StreamExtensions) |
| ReadStringCollection |
Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions) |
| ReadUInt16 |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadUInt32 |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| ReadUInt64 |
Reads the value from the stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the entire buffer to the stream (Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes a guid in little endian bytes to the stream
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| Write |
Writes the supplied value to
stream in little endian format.
(Defined by StreamExtensions) |
| WriteCollection |
Writes the supplied Collection to a Stream.
(Defined by StreamExtensions) |
| WriteCollection |
Writes the supplied Collection to a Stream.
(Defined by StreamExtensions) |
| WriteNullable |
Writes the supplied string to a Stream
in UTF8 encoding with a prefix if the value is null
(Defined by StreamExtensions) |
| WriteObject |
Encodes an object on a stream.
(Defined by StreamExtensions) |
| WriteWithLength |
Writes the supplied value to
stream along with prefixing the length
so it can be properly read as a unit.
(Defined by StreamExtensions) |
See Also