File: Telemetry\PersistenceChannel\PersistenceTransmitter.cs
Web Access
Project: ..\..\..\src\Cli\dotnet\dotnet.csproj (dotnet)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
#nullable disable
 
namespace Microsoft.DotNet.Cli.Telemetry.PersistenceChannel;
 
/// <summary>
///     Implements throttled and persisted transmission of telemetry to Application Insights.
/// </summary>
internal class PersistenceTransmitter : IDisposable
{
    /// <summary>
    ///     The number of times this object was disposed.
    /// </summary>
    private int _disposeCount;
 
    /// <summary>
    ///     A list of senders that sends transmissions.
    /// </summary>
    private readonly List<Sender> _senders = [];
 
    /// <summary>
    ///     The storage that is used to persist all the transmissions.
    /// </summary>
    private readonly BaseStorageService _storage;
 
    /// <summary>
    ///     Initializes a new instance of the <see cref="PersistenceTransmitter" /> class.
    /// </summary>
    /// <param name="storage">The transmissions storage.</param>
    /// <param name="sendersCount">The number of senders to create.</param>
    /// <param name="createSenders">
    ///     A boolean value that indicates if this class should try and create senders. This is a
    ///     workaround for unit tests purposes only.
    /// </param>
    internal PersistenceTransmitter(BaseStorageService storage, int sendersCount, bool createSenders = true)
    {
        _storage = storage;
        if (createSenders)
        {
            for (int i = 0; i < sendersCount; i++)
            {
                _senders.Add(new Sender(_storage, this));
            }
        }
    }
 
    /// <summary>
    ///     Gets or sets the interval between each successful sending.
    /// </summary>
    internal TimeSpan? SendingInterval { get; set; }
 
    /// <summary>
    ///     Disposes the object.
    /// </summary>
    public void Dispose()
    {
        if (Interlocked.Increment(ref _disposeCount) == 1)
        {
            StopSenders();
        }
    }
 
    /// <summary>
    ///     Stops the senders.
    /// </summary>
    /// <remarks>As long as there is no Start implementation, this method should only be called from Dispose.</remarks>
    private void StopSenders()
    {
        if (_senders == null)
        {
            return;
        }
 
        List<Task> stoppedTasks = [];
        foreach (Sender sender in _senders)
        {
            stoppedTasks.Add(sender.StopAsync());
        }
 
        Task.WaitAll([.. stoppedTasks]);
    }
}