ExtensionMethods.IAPIResourceView.Deprecated.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Linq;
using AnalyzeRe.Metrics;
 
// Disable warnings about snake_case function names in this method. While it goes against
// C# best-practice, it's done intentionally to follow the API conventions closely.
#pragma warning disable IDE1006
 
namespace AnalyzeRe
{
    public static partial class ExtensionMethods
    {
        // TODO: Delete Deprecated Methods after phase-out period.
        #region Deprecated Blocking Metrics Requests
        [Obsolete("Please provide a ProbabilityWindow rather than a double tail-probability. " +
            "This legacy method was less flexible and only returned the co-tail-metrics.")]
        public static CoMetrics co_metrics_blocking<T>(
            this IAPIResourceView thisView, double probability,
            IReference<T> component, CoMetricsOptions options,
            PollingOptions pollingOptions = null)
            where T : IAPIResourceView
        {
            return co_metrics_blocking(thisView, ProbabilityWindow.Tail(probability), component, options, pollingOptions);
        }
 
        [Obsolete("Please provide a list of ProbabilityWindows rather than doubles. " +
            "This legacy method was less flexible and only returned the co-tail-metrics.")]
        public static List<CoMetrics> co_metrics_blocking<T>(
            this IAPIResourceView thisView, List<double> probabilities,
            IReference<T> component, CoMetricsOptions options,
            PollingOptions pollingOptions = null)
            where T : IAPIResourceView
        {
            return co_metrics_blocking(thisView, probabilities.Select(ProbabilityWindow.Tail), component, options, pollingOptions);
        }
 
        [Obsolete("This method has been replaced with an overload that uses a PollingOptions object. " +
            "This legacy method was less flexible and only returned the co-tail-metrics.")]
        public static BackAllocations back_allocations_blocking(
            this IAPIResourceView thisView, string source_id,
            double minPollInterval = 0, double maxPollInterval = Double.MaxValue, double maxPollTotalTime = Double.MaxValue)
        {
            return API.PollUntilReady(() =>
                thisView.back_allocations(source_id),
                minPollInterval, maxPollInterval, maxPollTotalTime);
        }
        #endregion Deprecated Blocking Metrics Requests
    }
}