C# Class GSF.IO.FileStructure.Media.Footer

Show file Open project: GridProtectionAlliance/openHistorian

Public Methods

Method Description
ComputeChecksum ( IntPtr data, long &checksum1, int &checksum2, int length ) : void

Computes the custom checksum of the data.

This checksum is similiar to Adler

ComputeChecksumAndClearFooter ( IntPtr data, int blockSize ) : void

This event occurs right before something is committed to the disk. This gives the opportunity to finalize the data, such as updating checksums.

ComputeChecksumAndClearFooter ( IntPtr data, int blockSize, int length ) : void

This event occurs right before something is committed to the disk. This gives the opportunity to finalize the data, such as updating checksums.

WriteChecksumResultsToFooter ( IntPtr data, int blockSize ) : void

This event occurs any time new data is added to the BinaryStream's internal memory. It gives the consumer of this class an opportunity to properly initialize the data before it is handed to an IoSession.

WriteChecksumResultsToFooter ( IntPtr data, int blockSize, int length ) : void

This event occurs any time new data is added to the BinaryStream's internal memory. It gives the consumer of this class an opportunity to properly initialize the data before it is handed to an IoSession.

Method Details

ComputeChecksum() public static method

Computes the custom checksum of the data.
This checksum is similiar to Adler
public static ComputeChecksum ( IntPtr data, long &checksum1, int &checksum2, int length ) : void
data System.IntPtr the data to compute the checksum for.
checksum1 long the 64 bit component of this checksum
checksum2 int the 32 bit component of this checksum
length int the number of bytes to have in the checksum,Must
return void

ComputeChecksumAndClearFooter() public static method

This event occurs right before something is committed to the disk. This gives the opportunity to finalize the data, such as updating checksums.
public static ComputeChecksumAndClearFooter ( IntPtr data, int blockSize ) : void
data System.IntPtr
blockSize int
return void

ComputeChecksumAndClearFooter() public static method

This event occurs right before something is committed to the disk. This gives the opportunity to finalize the data, such as updating checksums.
public static ComputeChecksumAndClearFooter ( IntPtr data, int blockSize, int length ) : void
data System.IntPtr
blockSize int
length int
return void

WriteChecksumResultsToFooter() public static method

This event occurs any time new data is added to the BinaryStream's internal memory. It gives the consumer of this class an opportunity to properly initialize the data before it is handed to an IoSession.
public static WriteChecksumResultsToFooter ( IntPtr data, int blockSize ) : void
data System.IntPtr
blockSize int
return void

WriteChecksumResultsToFooter() public static method

This event occurs any time new data is added to the BinaryStream's internal memory. It gives the consumer of this class an opportunity to properly initialize the data before it is handed to an IoSession.
public static WriteChecksumResultsToFooter ( IntPtr data, int blockSize, int length ) : void
data System.IntPtr
blockSize int
length int
return void