IPacket Interface

Defines a binary packet received by a historian.

Namespace: GSF.Historian.Packets
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public interface IPacket : ISupportSourceIdentifiableFrameImage<Guid, short>, 
	ISupportFrameImage<short>, ISupportBinaryImage

Public Interface IPacket
	Inherits ISupportSourceIdentifiableFrameImage(Of Guid, Short), ISupportFrameImage(Of Short), 
	ISupportBinaryImage

public interface class IPacket : ISupportSourceIdentifiableFrameImage<Guid, short>, 
	ISupportFrameImage<short>, ISupportBinaryImage

type IPacket = 
    interface
        interface ISupportSourceIdentifiableFrameImage<Guid, int16>
        interface ISupportFrameImage<int16>
        interface ISupportBinaryImage
    end

GSF.Historian.Packets.IPacket = function();
GSF.Historian.Packets.IPacket.createInterface('GSF.Historian.Packets.IPacket');

View Source

The IPacket type exposes the following members.

Properties

	Name	Description
	AllowQueuedPublication	Gets flag that determines if frame image can queued for publication or should be processed immediately. (Inherited from ISupportFrameImageTTypeIdentifier)
	Archive	Gets or sets the current IArchive.
	BinaryLength	Gets the length of the binary image. (Inherited from ISupportBinaryImage)
	CommonHeader	Gets or sets current ICommonHeaderTTypeIdentifier. (Inherited from ISupportFrameImageTTypeIdentifier)
	PreProcessHandler	Gets or sets the Delegate that pre-processes the packet.
	ProcessHandler	Gets or sets the Delegate that processes the packet.
	Source	Gets or sets the data source identifier of the frame image. (Inherited from ISupportSourceIdentifiableFrameImageTSourceIdentifier, TTypeIdentifier)
	TypeID	Gets the identifier that can be used for identifying the Type. (Inherited from ISupportFrameImageTTypeIdentifier)

Top

Methods

	Name	Description
	ExtractTimeSeriesData	Extracts time-series data from the packet.
	GenerateBinaryImage	Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes. (Inherited from ISupportBinaryImage)
	ParseBinaryImage	Initializes object by parsing the specified buffer containing a binary image. (Inherited from ISupportBinaryImage)

Top

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)

Top

Reference

GSF.Historian.Packets Namespace