⌛Progress Handlers

Please wait while we're processing your request...

The progress handlers allow you to handle how you want to notify that there is progress going on. For long operations that are split to short operations, such as showing what files are being copied for every single file, you can use this facility to register and unregister your progress handlers.

When registration is complete, you should be notified about the progress of an operation, depending on how you defined the progress handling action.

Every progress handler can be created using the following constructor:

ProgressHandler.cs

public ProgressHandler(Action<double, string> progressAction, string context)

The progress handler manager allows you to register and unregister your progress handler, given that you already keep the progress handler handy in any way possible in case you want to unregister it.

ProgressManager.cs

public static void RegisterProgressHandler(ProgressHandler handler)
public static void UnregisterProgressHandler(ProgressHandler handler)

For example, this is the bit of code needed to register your progress handler.

Example code

var handler = new ProgressHandler((num, text) =>
    TextWriterColor.WriteKernelColor($"{num}% {text}", KernelColorType.Progress)
    , "General");
ProgressManager.RegisterProgressHandler(handler);

This is the bit of code to unregister your handler, given that you've kept the handler handy:

Example code

ProgressManager.UnregisterProgressHandler(handler);

After you register the handler, you can report the progress using the same context using one of the following functions:

public static void ReportProgress(double progress, string context)
public static void ReportProgress(double progress, string context, string message)
public static void ReportProgress(double progress, string context, string message, params object[] vars)

Any call to one of these ReportProgress() functions with the correct context that is handled will follow it the progress indicator showing on your screen, or any other progress action, depending on how you're handling the progress.

For example, this is the simplest method to report the progress, assuming that this is reported inside a long operation loop:

Example code

ProgressManager.ReportProgress(progress, "General", Translate.DoTranslation("Initializing..."));

You must write the context correctly, as it is case-sensitive. Trying to report a progress on a non-existent context will simply do nothing.

Full example code

This is the full example code that registers progress handlers for two contexts and reports the progress on them until the progress reaches 100%.

TestProgressHandler.cs

using Nitrocid.ConsoleBase.Colors;
using Nitrocid.ConsoleBase.Writers;
using Nitrocid.Languages;
using Nitrocid.Misc.Progress;
using System.Threading;

namespace KS.Kernel.Debugging.Testing.Facades
{
    internal class TestProgressHandler : TestFacade
    {
        public override string TestName => Translate.DoTranslation("Tests the progress handler");
        public override void Run(params string[] args)
        {
            int progress = 0;
            var handler = new ProgressHandler((num, text) =>
                TextWriters.Write($"{num}% {text}", KernelColorType.Progress)
            , "General");
            var handler2 = new ProgressHandler((num, text) =>
                TextWriters.Write($"{num}% {text}", KernelColorType.NeutralText)
            , "Nongeneral");
            ProgressManager.RegisterProgressHandler(handler);
            ProgressManager.RegisterProgressHandler(handler2);
            while (progress != 100)
            {
                Thread.Sleep(100);
                progress += 1;
                ProgressManager.ReportProgress(progress, "General", Translate.DoTranslation("Initializing..."));
                ProgressManager.ReportProgress(progress, "Nongeneral", Translate.DoTranslation("Initializing..."));
            }
            ProgressManager.UnregisterProgressHandler(handler);
            ProgressManager.UnregisterProgressHandler(handler2);
        }
    }
}