Interface IDataWriter

A data writer.

public interface IDataWriter

Methods

Closes the current and flushes the data to disk.

Task CloseAsync(CancellationToken cancellationToken)

cancellationToken CancellationToken: A token to cancel the current operation.

Opens or creates a file for the specified parameters.

Task OpenAsync(DateTime fileBegin, TimeSpan filePeriod, TimeSpan samplePeriod, CatalogItem[] catalogItems, CancellationToken cancellationToken)

fileBegin DateTime: The beginning of the file.
filePeriod TimeSpan: The period of the file.
samplePeriod TimeSpan: The sample period.
catalogItems CatalogItem[]: An array of catalog items to allow preparation of the file header.
cancellationToken CancellationToken: A token to cancel the current operation.

Invoked by Nexus right after construction to provide the context.

Task SetContextAsync(DataWriterContext context, ILogger logger, CancellationToken cancellationToken)

context DataWriterContext: The context.
logger ILogger: The logger.
cancellationToken CancellationToken: A token to cancel the current operation.

Performs a number of write requests.

Task WriteAsync(TimeSpan fileOffset, WriteRequest[] requests, IProgress<double> progress, CancellationToken cancellationToken)

fileOffset TimeSpan: The offset within the current file.
requests WriteRequest[]: The array of write requests.
progress IProgress<double>: An object to report the write progress between 0.0 and 1.0.
cancellationToken CancellationToken: A token to cancel the current operation.