A simple way to represent the progress of a long-running task in a C# console app. Targets .NET Core 2.0.
-
ConsoleProgressBar
- Implements
IProgress<double>TheIProgressinterface greatly simplifies the effort to report progress from anasyncmethod to the UI, clunky boilerplate code to ensure thread-safety is not required since theSynchronizationContextis captured when the progress bar is instantiated. - Efficient and light-weight
Consolecan become sluggish and unresponsive when called frequently, this progress bar only performs 8 calls/second regardless of how often progress is reported. - Customizable Each component of the progress bar (start/end brackets, completed/incomplete blocks, progress animation) can be set to any string value through public properties and each item displayed (the progress bar itself, percentage complete, animation) can be shown or hidden.
- Implements
-
FileTransferProgressBar
- Extends ConsoleProgressBar and adds the ability to detect when a file transfer has stalled.
- If the time since last progress reported exceeds the
TimeSpanFileStalledvalue, theFileTransferStalledevent fires. - Provides further customization of the display with the ability to show/hide the bytes received and file size in bytes
Numbers correspond to the examples shown above, full source code for examples can be found in ./TestConsole/Program.cs
// 1. Default behavior
var pb1 = new ConsoleProgressBar();
await TestProgressBar(pb1, 1);
// 2. Customized all progress bar components
var pb2 = new ConsoleProgressBar
{
NumberOfBlocks = 18,
StartBracket = string.Empty,
EndBracket = string.Empty,
CompletedBlock = "\u2022",
IncompleteBlock = "·",
AnimationSequence = ProgressAnimations.RotatingPipe
};
await TestProgressBar(pb2, 2);
// 3. Hide progress bar
var pb3 = new ConsoleProgressBar
{
DisplayBar = false,
AnimationSequence = ProgressAnimations.RotatingTriangle
};
await TestProgressBar(pb3, 3);
// 4. Customized progress bar, successful file transfer
const long fileSize = (long)(8 * FileHelper.OneKB);
var pb4 = new FileTransferProgressBar(fileSize, TimeSpan.FromSeconds(5))
{
NumberOfBlocks = 15,
StartBracket = "|",
EndBracket = "|",
CompletedBlock = "|",
IncompleteBlock = "\u00a0",
AnimationSequence = ProgressAnimations.PulsingLine
};
await TestFileTransferProgressBar(pb4, fileSize, 4);
// 5. Hide progress bar and animation, unsuccessful file transfer
const long fileSize2 = (long)(100 * 36 * FileHelper.OneMB);
var pb5 = new FileTransferProgressBar(fileSize2, TimeSpan.FromSeconds(5))
{
DisplayBar = false,
DisplayAnimation = false
};
pb5.FileTransferStalled += HandleFileTransferStalled;
await TestFileTransferStalled(pb5, fileSize2, 5);