duplicati/Duplicati/Library/Utility/ProgressReportingStream.cs
Kenneth Skovhede f393c00030 Fixed throttle support
This moves the throttle support to the StreamUtil throttled stream, which allows multiple streams to share a throttle value, such that the throttle setting is applied to the entire communication from Duplicati, and not for each connection.

This also cleans up a bit in the progress reporting, where the backend manager now keeps track of the "active" transfer and only emits progress on that. Once it finishes, a new transfer is promoted a "active".
2025-04-22 22:54:48 +02:00

72 lines
2.8 KiB
C#

// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using System;
using System.Threading;
using System.Threading.Tasks;
using Duplicati.StreamUtil;
namespace Duplicati.Library.Utility
{
/// <summary>
/// This is a stream wrapper that reports the current progress of reading or writing the stream to the supplied delegate
/// </summary>
public class ProgressReportingStream : WrappingAsyncStream
{
private readonly Action<long> m_progress;
private long m_streamOffset;
public ProgressReportingStream(System.IO.Stream basestream, Action<long> progress)
: base(basestream)
{
m_streamOffset = 0;
m_progress = progress;
}
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
protected override async Task<int> ReadImplAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
{
ReportProgress();
var res = await BaseStream.ReadAsync(buffer, offset, count, cancellationToken).ConfigureAwait(false);
m_streamOffset += res;
ReportProgress();
return res;
}
protected override async Task WriteImplAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
{
ReportProgress();
await BaseStream.WriteAsync(buffer, offset, count, cancellationToken);
m_streamOffset += count;
ReportProgress();
}
private void ReportProgress()
{
if (m_progress != null)
m_progress(m_streamOffset);
}
}
}