{"id":1141,"date":"2014-01-13T13:00:03","date_gmt":"2014-01-13T13:00:03","guid":{"rendered":"http:\/\/writeasync.net\/?p=1141"},"modified":"2014-01-06T03:41:53","modified_gmt":"2014-01-06T03:41:53","slug":"providing-async-functionality-for-system-diagnostics-process","status":"publish","type":"post","link":"http:\/\/writeasync.net\/?p=1141","title":{"rendered":"Providing async functionality for System.Diagnostics.Process"},"content":{"rendered":"

If you need to interact with processes in .NET, you could do worse than System.Diagnostics.Process<\/code><\/a>. But you could also do a bit<\/em> better, especially since Process<\/code> provides no out-of-the-box asynchronous methods. But we can fix that!<\/p>\n

Let’s devise a ProcessEx<\/code> class that provides async versions of the Start<\/code><\/a> and WaitForExit<\/code><\/a> methods. Here is the class overview:<\/p>\n

\r\npublic sealed class ProcessEx : IDisposable\r\n{\r\n    private ProcessEx(Process process);\r\n\r\n    public Process Inner { get; }\r\n\r\n    public static Task<ProcessEx> StartAsync(ProcessStartInfo psi);\r\n\r\n    public Task WaitForExitAsync();\r\n\r\n    public Task<bool> WaitForExitAsync(TimeSpan timeout);\r\n\r\n    public void Dispose();\r\n}\r\n<\/pre>\n
The constructor is private since we will only support instantiating ProcessEx<\/code> via the StartAsync<\/code> factory method:<\/p>\n
\r\npublic static Task<ProcessEx> StartAsync(ProcessStartInfo psi)\r\n{\r\n    return Task.Factory.StartNew(i => new ProcessEx(Process.Start((ProcessStartInfo)i)), psi);\r\n}\r\n<\/pre>\n
Unfortunately, there is no Windows API to asynchronously start a process so we are stuck offloading the blocking Process.Start<\/code> call to a worker thread. Okay, so what do we do now that we have our hands on a Process<\/code> instance? Well, we need to ensure that EnableRaisingEvents<\/code><\/a> is set to true<\/code> so that we can be notified via the Exited<\/code><\/a> event when the process exits. This will enable us to build a simple async version of WaitForExit<\/code>, using our old friend TaskCompletionSource<\/code><\/a>. Here is the relevant code:<\/p>\n
\r\nprivate readonly Process process;\r\nprivate readonly TaskCompletionSource<bool> exited;\r\n\r\nprivate ProcessEx(Process process)\r\n{\r\n    this.process = process;\r\n    this.exited = new TaskCompletionSource<bool>();\r\n    this.process.EnableRaisingEvents = true;\r\n    this.process.Exited += this.OnProcessExited;\r\n    if (this.process.HasExited)\r\n    {\r\n        this.exited.TrySetResult(false);\r\n    }\r\n}\r\n\r\npublic Process Inner\r\n{\r\n    get { return this.process; }\r\n}\r\n\r\npublic Task WaitForExitAsync()\r\n{\r\n    return this.exited.Task;\r\n}\r\n\r\nprivate void OnProcessExited(object sender, EventArgs e)\r\n{\r\n    this.exited.TrySetResult(false);\r\n}\r\n<\/pre>\n
Note the use of TrySetResult<\/code><\/a> rather than SetResult<\/code><\/a> and the explicit check of HasExited<\/code><\/a>. This is to handle two potential race conditions:<\/p>\n
    \n
  1. The Exited<\/code> event may never be raised since the process could have already exited by the time we subscribe.\n<\/li>\n
  2. The check of HasExited<\/code> may occur at the same time the OnProcessExited<\/code> handler is invoked.<\/li>\n<\/ol>\n
    Let’s get Dispose<\/code> out of the way. To avoid WaitForExitAsync<\/code> from blocking forever, we’ll attempt to complete it with an ObjectDisposedException<\/code><\/a>:<\/p>\n
    \r\npublic void Dispose()\r\n{\r\n    this.Dispose(true);\r\n    GC.SuppressFinalize(this);\r\n}\r\n\r\nprivate void Dispose(bool disposing)\r\n{\r\n    if (disposing)\r\n    {\r\n        this.process.EnableRaisingEvents = false;\r\n        this.process.Exited -= this.OnProcessExited;\r\n        this.exited.TrySetException(new ObjectDisposedException("ProcessEx"));\r\n        this.process.Dispose();\r\n    }\r\n}\r\n<\/pre>\n
    Now we need to implement the overload of WaitForExitAsync<\/code> that accepts a timeout: <\/p>\n
    \r\npublic async Task<bool> WaitForExitAsync(TimeSpan timeout)\r\n{\r\n    TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();\r\n    using (CancellationTokenSource cts = new CancellationTokenSource())\r\n    {\r\n        Task exitedTask = this.exited.Task;\r\n        Task completedTask;\r\n        using (cts.Token.Register(o => ((TaskCompletionSource<bool>)o).SetResult(false), tcs))\r\n        {\r\n            cts.CancelAfter(timeout);\r\n            completedTask = await Task.WhenAny(tcs.Task, exitedTask);\r\n        }\r\n\r\n        bool result = false;\r\n        if (completedTask == exitedTask)\r\n        {\r\n            await exitedTask;\r\n            result = true;\r\n        }\r\n\r\n        return result;\r\n    }\r\n}\r\n<\/pre>\n
    Basically, we need to await the result of two operations, one tracking the timeout (tcs<\/code> above) and the other tracking process exit (this.exited<\/code>). The timeout task will only complete if the timeout expires before the process actually exits. To manage this, we use CancellationTokenSource.CancelAfter<\/code><\/a> and a CancellationTokenRegistration<\/code><\/a> which will complete the timeout task. (Note that if the CancellationToken<\/code><\/a> is already in a canceled state, Register<\/code><\/a> will run the callback immediately, so there is no race here.) We use Task.WhenAny<\/code><\/a> to notify us when either<\/em> task completes. (Since we are good citizens, we Dispose<\/code><\/a> the registration after this point since we don’t need it anymore.) If the first task to complete indicates that the process exited, we await the task (in case it completed with an exception) and return true. Otherwise, the process is still running as far as we know and we return false.<\/p>\n
    That’s all there is to it. Here is a simple use case of creating a file, opening a Notepad window to display it, and waiting for the user to close it:<\/p>\n
    \r\ninternal sealed class Program\r\n{\r\n    private static void Main(string[] args)\r\n    {\r\n        MainAsync().Wait();\r\n    }\r\n\r\n    private static async Task MainAsync()\r\n    {\r\n        string fileName = Environment.ExpandEnvironmentVariables(@"%TEMP%\\SampleFile.txt");\r\n        using (FileStream stream = CreateAsyncStream(fileName))\r\n        {\r\n            string text = "Close this window to unblock app.";\r\n            byte[] buffer = Encoding.ASCII.GetBytes(text);\r\n            await stream.WriteAsync(buffer, 0, buffer.Length);\r\n        }\r\n\r\n        using (ProcessEx process = await ProcessEx.StartAsync(new ProcessStartInfo("notepad.exe", fileName)))\r\n        {\r\n            bool exited;\r\n            do\r\n            {\r\n                Console.WriteLine("Waiting for process to exit...");\r\n                exited = await process.WaitForExitAsync(TimeSpan.FromSeconds(1.0d));\r\n            }\r\n            while (!exited);\r\n        }\r\n\r\n        Console.WriteLine("Done.");\r\n    }\r\n\r\n    private static FileStream CreateAsyncStream(string fileName)\r\n    {\r\n        return new FileStream(fileName, FileMode.Create, FileAccess.Write, FileShare.Read, 65536);\r\n    }\r\n}\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
    If you need to interact with processes in .NET, you could do worse than System.Diagnostics.Process. But you could also do a bit better, especially since Process provides no out-of-the-box asynchronous methods. But we can fix that! Let’s devise a ProcessEx… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[21],"tags":[],"class_list":["post-1141","post","type-post","status-publish","format-standard","hentry","category-async"],"_links":{"self":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/1141","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1141"}],"version-history":[{"count":0,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/1141\/revisions"}],"wp:attachment":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1141"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1141"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1141"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}