ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue> Interface
HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries
Section titled “HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries”Provides methods to either collect single ICompressedTimeSeriesData<TCompressedValue> entries and write them all at once or stream the ICompressedTimeSeriesData<TCompressedValue> entries, depending on the storage.
public interface ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue> : HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ICompressedTimeSeriesDataCollectionStorageWriter, System.IDisposable, System.IAsyncDisposableType parameters
Section titled “Type parameters”TCompressedValue
The value type of the compressed data.
Implements ICompressedTimeSeriesDataCollectionStorageWriter, System.IDisposable, System.IAsyncDisposable
Methods
Section titled “Methods”ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Configure(ITimeSeriesReference, ITsmRepositoryInformation, ITimeSeriesDataStoreConfiguration, DateTimeOffset) Method
Section titled “ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Configure(ITimeSeriesReference, ITsmRepositoryInformation, ITimeSeriesDataStoreConfiguration, DateTimeOffset) Method”Configures the current ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.
void Configure(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.TSM.Net.Api.Persistence.ITsmRepositoryInformation repositoryInformation, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataStoreConfiguration configuration, System.DateTimeOffset historicDateTime);Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference containing additional information where the compressed data should be stored to.
repositoryInformation ITsmRepositoryInformation
The ITsmRepositoryInformation containing the repository where the compressed data should be stored to.
configuration ITimeSeriesDataStoreConfiguration
The ITimeSeriesDataStoreConfiguration with information about where to store the compressed data in the repository.
historicDateTime System.DateTimeOffset
The date used for historical retention of the data.
ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Flush(CancellationToken) Method
Section titled “ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Flush(CancellationToken) Method”Clears buffers and causes any buffered data to be written to the storage.
System.Threading.Tasks.Task Flush(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
An awaitable System.Threading.Tasks.Task.
ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.TryFlush(CancellationToken) Method
Section titled “ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.TryFlush(CancellationToken) Method”Attempts to clear buffers and write buffered data to the storage.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryFlush(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
An awaitable System.Threading.Tasks.Task<> containing information about the success or failure of the attempt.
ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Write(ICompressedTimeSeriesData<TCompressedValue>, CancellationToken) Method
Section titled “ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Write(ICompressedTimeSeriesData<TCompressedValue>, CancellationToken) Method”Writes data to the storage of the configured store or adds it to a buffer which will be saved with Flush(CancellationToken).
System.Threading.Tasks.Task Write(HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”data HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue>
The ICompressedTimeSeriesData<TCompressedValue> to save.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
An awaitable System.Threading.Tasks.Task.
ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Write(IAsyncEnumerable<ICompressedTimeSeriesData<TCompressedValue>>, CancellationToken) Method
Section titled “ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.Write(IAsyncEnumerable<ICompressedTimeSeriesData<TCompressedValue>>, CancellationToken) Method”Writes a collection to the storage of the configured store or adds it to a buffer which will be saved with Flush(CancellationToken).
System.Threading.Tasks.Task Write(System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue>> collection, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”collection System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue>>
The System.Collections.Generic.IAsyncEnumerable<> of ICompressedTimeSeriesData<TCompressedValue> to save.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
An awaitable System.Threading.Tasks.Task.
ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.WriteHistoricData(ICompressedTimeSeriesData<TCompressedValue>, CancellationToken) Method
Section titled “ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.WriteHistoricData(ICompressedTimeSeriesData<TCompressedValue>, CancellationToken) Method”Writes data to the history storage of the configured store or adds it to a buffer which will be saved with Flush(CancellationToken).
System.Threading.Tasks.Task WriteHistoricData(HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”data HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue>
The ICompressedTimeSeriesData<TCompressedValue> to save.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
An awaitable System.Threading.Tasks.Task.
ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.WriteWithHistoricData(ICompressedTimeSeriesData<TCompressedValue>, CancellationToken) Method
Section titled “ICompressedTimeSeriesDataCollectionStorageWriter<TCompressedValue>.WriteWithHistoricData(ICompressedTimeSeriesData<TCompressedValue>, CancellationToken) Method”Writes data to the storage and history storage of the configured store or adds it to a buffer which will be saved with Flush(CancellationToken).
System.Threading.Tasks.Task WriteWithHistoricData(HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”data HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ICompressedTimeSeriesData<TCompressedValue>
The ICompressedTimeSeriesData<TCompressedValue> to save.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
An awaitable System.Threading.Tasks.Task.