Proper Threading in Winforms .NET

太过爱你忘了你带给我的痛 2022-08-13 12:44 144阅读 0赞

原文：[http://www.codeproject.com/Articles/4201/Proper-Threading-in-Winforms-NET][http_www.codeproject.com_Articles_4201_Proper-Threading-in-Winforms-NET]

*  [Download source files - 12.8 Kb][]

## Introduction ##

This is a small sample application that I built, to figure out how to "properly" do background threading in Winforms under .NET.

There is a well known rule that in the Win32 environment, a control is "owned" by the thread that created it; therefore, no other thread should (or can) safely update a control in any manner. All updates should be "posted" to the thread that owns the control. This posting actually takes place in the examples, by using the Windows Message loop - something that has existed back from Win 3.0 (perhaps earlier) days. This Message Loop still exists in .NET and forms the basis of a "Single Threaded Apartment" which VB 6 knows all too well.

All the stuff I had read was confusing, had all the methods for the work in one single class (WinForm) file. This made it difficult to see the "separation" of the form elements and where the work would be done -- and how to signal back to the caller in a separate class.

I think this is a littler easier to understand.

## Walkthrough ##

The application's form is pretty simple:

![Sample screenshot][]

There is a delegate declaration that identifies the callback that the worker class method will utilize, to signal to the form, what information the primary form's method needs to update, the status of the `WorkerClass` processing.

![minus.gif][]  Collapse  |  [Copy Code][]

delegate void ShowProgressDelegate ( int totalMessages, 
                        int messagesSoFar, bool statusDone );

Within the form, the click event fires the method below:

![minus.gif][]  Collapse  |  [Copy Code][]

private void button1_Click(object sender, System.EventArgs e)
    {
        ShowProgressDelegate showProgress = new 
                                    ShowProgressDelegate(ShowProgress);
        int imsgs = 100;
        if ( cbThreadPool.Checked )
        {
            object obj = new object[] { this, showProgress, imsgs };
            WorkerClass wc = new WorkerClass();
            bool rc = ThreadPool.QueueUserWorkItem( new WaitCallback 
                                                (wc.RunProcess), obj);
            EnableButton( ! rc );
       }
       else 
       {
            //another way.. using straight threads
            //WorkerClass wc = new WorkerClass( this, showProgress, imsgs);
            WorkerClass wc = new WorkerClass( this, 
                    showProgress, new object[] { imsgs } );
            Thread t = new Thread( new ThreadStart(wc.RunProcess));
            //make them a daemon - prevent thread callback issues
            t.IsBackground = true; 
            t.Start();
            EnableButton ( false );
       } 
    }

The path taken is based upon the status of the `CheckBox`. The path is either use `ThreadPool` or a `ThreadStart`object. With the `ThreadStart` object, the only way to get "state" into the `WorkerClass` is via the constructor. So, I've implemented `WorkerClass` with 2 constructors that take parameters. The first constructor is a strict 3 param constructor. The second takes the same first 2 params, but the 3rd is a parameter array, allowing more flexibility in future implementations. The sample application only uses the 3 param constructor when the check box is not enable.

Regardless, the first 2 params setup the callback target for `WorkerClass`.

The `ShowProgress` method takes a simple list of 3 params that are used to update the text box and progress bar...

![minus.gif][]  Collapse  |  [Copy Code][]

private void ShowProgress ( int totalMessages, int messagesSoFar, bool done )
    {
        textBox1.Text = String.Format( messagesSoFar.ToString() );
        progressBar1.Value = messagesSoFar;
        if ( done ) EnableButton ( done );
    }

The `WorkerClass` constructor that we'll look at here is the one that takes the param list on the end:

![minus.gif][]  Collapse  |  [Copy Code][]

public WorkerClass ( ContainerControl sender, 
                    Delegate senderDelegate, params object[] list)
    {
        m_sender = sender;
        m_senderDelegate = senderDelegate;
        m_totalMessages = (int) list.GetValue(0);
    }

This just sets up internal members to designate the `Form` and `Form`'s method to call when `ShowProgress` needs to be called.

Now, the actual work is done in `LocalRunProcess` using internal instance members. The `public` method`RunProcess` provide the entry point for the caller. The current thread is also forced `IsBackground` (make it a daemon) so if the parent thread exits, all child threads will be aborted too.

`LocalRunProcess` calls `BeginInvoke` (Invoke is the synchronous method) on the sender, passing the delegate instance that was passed in by form on `WorkerClass` construction. This method call initiates a background call to place a message on the message loop for the form.

![minus.gif][]  Collapse  |  [Copy Code][]

private void LocalRunProcess()
    {
        int i = 0;
        for ( ; i < m_totalMessages; i++)
        {
            Thread.Sleep(50);
            m_sender.BeginInvoke( m_senderDelegate, 
                    new object[] { m_totalMessages, i, false } );
        }
        m_sender.BeginInvoke( m_senderDelegate, 
                    new object[] { m_totalMessages, i, true } );
    }

![minus.gif][]  Collapse  |  [Copy Code][]

public void RunProcess()
    {
        Thread.CurrentThread.IsBackground = true; //make them a daemon
        LocalRunProcess();
    }

## Recommended reads ##

A few good articles on Winforms, and Winforms over the web. You'll see the confusion in the 1st 2 articles.

*  Safe, Simple Multithreading in Windows Forms - [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnforms/html/winforms06112002.asp][http_msdn.microsoft.com_library_default.asp_url_library_en-us_dnforms_html_winforms06112002.asp]
 *  [A Second Look at Windows Forms Multithreading - ][http_msdn.microsoft.com_library_default.asp_url_library_en-us_dnforms_html_winforms06112002.asp][http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnforms/html/winforms08162002.asp][http_msdn.microsoft.com_library_default.asp_url_library_en-us_dnforms_html_winforms08162002.asp]
 *  [Winform over the web - ][http_msdn.microsoft.com_library_default.asp_url_library_en-us_dnforms_html_winforms08162002.asp][http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dndotnet/html/dplywithnet.asp][http_msdn.microsoft.com_library_default.asp_url_library_en-us_dndotnet_html_dplywithnet.asp]

[http_www.codeproject.com_Articles_4201_Proper-Threading-in-Winforms-NET]: http://www.codeproject.com/Articles/4201/Proper-Threading-in-Winforms-NET
[Download source files - 12.8 Kb]: http://www.codeproject.com/KB/cs/winformThreading/winformThreading.zip
[Sample screenshot]: /images/20220810/ff050710e5164f129819d81f84a7cd75.png
[minus.gif]: /images/20220810/051fafd09b674317b8aa090479216fc8.png
[Copy Code]: http://www.codeproject.com/Articles/4201/Proper-Threading-in-Winforms-NET#
[http_msdn.microsoft.com_library_default.asp_url_library_en-us_dnforms_html_winforms06112002.asp]: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnforms/html/winforms06112002.asp
[http_msdn.microsoft.com_library_default.asp_url_library_en-us_dnforms_html_winforms08162002.asp]: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnforms/html/winforms08162002.asp
[http_msdn.microsoft.com_library_default.asp_url_library_en-us_dndotnet_html_dplywithnet.asp]: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dndotnet/html/dplywithnet.asp

发表评论取消回复

表情：

评论列表（有 0 条评论，144人围观）

还没有评论，来说两句吧...

相关阅读

相关 Exception in thread “main“ java.net.BindException: Address already in use: JVM_Bind

Exception in thread "main" java.net.BindException: Address already in use: JVM_Bind

今天药忘吃喽~/ 2024年03月25日 20:13/ 0 赞/ 62 阅读

相关 FastReport.net 使用 Winform WebForm打印

delphi用的fastreport比较多所以。net中也研究一下用法,这个打印控件还是很简单的只要手动设计一下写少许代码就可以打印了甚至可以写成通用代码以后就可以不用

野性酷女/ 2023年08月17日 17:00/ 0 赞/ 154 阅读

相关 Exception in thread "main" java.net.SocketException: error setting options

> 今天在做UDP组播发送和接收数据的时候，遇到一个错误，如下： ![20191223172954889.png][] > public static void main(

蔚落/ 2023年06月24日 14:24/ 0 赞/ 14 阅读

相关 Silverlight Hosted in Winforms

I think using the Windows Forms WebBrowser control is your best bet. To do this, you'll

短命女/ 2022年10月02日 06:55/ 0 赞/ 100 阅读

相关 Iocomp .NET WinForms OPC Crack

Iocomp .NET WinForms OPC 包 Iocomp .NET WinForms OPC Pack 是一款独立产品，可将 OPC 功能添加到任何 .NET 控

骑猪看日落/ 2022年09月09日 02:10/ 0 赞/ 230 阅读

相关 Iocomp .NET WinForms Ultra Pack Crack

Iocomp .NET WinForms Ultra Pack--Ω578867473 The Iocomp .NET WinForms Ultra Pack contro

清疚/ 2022年09月06日 14:28/ 0 赞/ 222 阅读

相关 Proper Threading in Winforms .NET

原文：[http://www.codeproject.com/Articles/4201/Proper-Threading-in-Winforms-NET][http_www.

太过爱你忘了你带给我的痛/ 2022年08月13日 12:44/ 0 赞/ 145 阅读

相关 Exception in thread "Thread-13" java.util.ConcurrentModificationException

参考：http://blog.163.com/asd\_wll/blog/static/210310402011627609901/ 经常我们要删除集合中的某些元

落日映苍穹つ/ 2022年04月11日 09:15/ 0 赞/ 818 阅读

相关 HIVE Exception in thread "main" java.lang.IllegalArgumentException: java.net.URIS

将hive-site.xml文件中的$\{system:java.io.tmpdir\}替换为hive的临时目录![20190524132710371.png][] [20

灰太狼/ 2022年01月28日 17:17/ 0 赞/ 310 阅读

相关 Threads in Spring

使用Spring时经常会问，我们定义的Bean应该是Singleton还是Prototype？多个客户端同时调用Dao层，需要考虑线程安全吗？通过阅读官方文档和Spring的源

曾经终败给现在/ 2021年11月24日 00:48/ 0 赞/ 155 阅读