CompactMeasurementExtensionsCompressPayload Method

public static bool CompressPayload(
	this IEnumerable<CompactMeasurement> compactMeasurements,
	BlockAllocatedMemoryStream destination,
	byte compressionStrength,
	bool includeTime,
	ref DataPacketFlags flags
)

<ExtensionAttribute>
Public Shared Function CompressPayload ( 
	compactMeasurements As IEnumerable(Of CompactMeasurement),
	destination As BlockAllocatedMemoryStream,
	compressionStrength As Byte,
	includeTime As Boolean,
	ByRef flags As DataPacketFlags
) As Boolean

public:
[ExtensionAttribute]
static bool CompressPayload(
	IEnumerable<CompactMeasurement^>^ compactMeasurements, 
	BlockAllocatedMemoryStream^ destination, 
	unsigned char compressionStrength, 
	bool includeTime, 
	DataPacketFlags% flags
)

[<ExtensionAttribute>]
static member CompressPayload : 
        compactMeasurements : IEnumerable<CompactMeasurement> * 
        destination : BlockAllocatedMemoryStream * 
        compressionStrength : byte * 
        includeTime : bool * 
        flags : DataPacketFlags byref -> bool 

GSF.TimeSeries.Transport.CompactMeasurementExtensions.CompressPayload = function(compactMeasurements, destination, compressionStrength, includeTime, flags);

Parameters

compactMeasurements  IEnumerableCompactMeasurement

Payload of CompactMeasurement values.

destination  BlockAllocatedMemoryStream

Memory based destination stream to hold compressed payload.

compressionStrength  Byte

Compression strength to use.

includeTime  Boolean

Flag that determines if time should be included in the compressed payload.

flags  DataPacketFlags

Current DataPacketFlags.

Return Value

Usage Note

Compressed payload will only be encoded onto destination stream if compressed size would be smaller than normal serialized size.

As an optimization this function uses a compression method that uses pointers to native structures, as such the endian order encoding of the compressed data will always be in the native-endian order of the operating system. This will be an important consideration when writing a endian order neutral payload decompressor. To help with this the actual endian order used during compression is marked in the data flags. However, measurements values are consistently encoded in big-endian order prior to buffer compression.

Reference