Cross Thread Operation - Invoked function calls another function C# - c#

I have a program which uses many threads, when one of the threads found an answer (I think the context doesn't really matter) - it announces it, and then the first thread I created calles a function in a user control class using Invoke.
I checked - and if I change any attributes in this function, I do not get the cross-thread operation. But this function starts a timer (System.Timers.Timer) -> so the function of the "Elapsed" event is called. Inside it I am trying to change an attribute, and that causes cross-thread operation. What am I doing wrong? Isn't it possible to have the invoked function calling another function and then change the attributes in there?
By the way, is it wrong to invoke functions using the delegate? I mean, having the delegate as an attribute of the class I need it in, and then using delegAttributeName.Invoke(parameters) - and not this.Invoke(new Delegate(), parameters);
Heres part of the code:
Thats is where I invoke the function:
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Threading;
namespace Nim_Assignment_3
{
public delegate void drawDeleg(Color c, int amount, int rowNumber);
public partial class Nim : Form
{
private event drawDeleg myDrawDeleg;
private void CheckXor()
{
if (this.foundToPaint)
{
this.myDrawDeleg.Invoke(this.currentTurnColor, this.amountToPaint, this.rowToPaint);
this.drawWait.WaitOne();
this.foundToPaint = false;
if (this.currentTurnColor == Color.Blue)
this.currentTurnColor = Color.Red;
else
this.currentTurnColor = Color.Blue;
}
}
// the invoked function:
private void callFillPencils(Color c, int amount, int rowNumber)
{
this.rows[rowNumber].fillPencils(c, amount);
}
}
}
And this is the function that the invoked function is calling - and the one it calls (the timer-elapsed event function):
(fillPencils - the function that the invoked function in the Form class (Nim) is calling):
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Data;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Timers;
namespace Nim_Assignment_3
{
public partial class PencilsUC : UserControl
{
private PictureBox[] pencils;
public static Image grayPencil = new Bitmap("GrayPen.bmp"), bluePencil = new Bitmap("BluePen.bmp"), redPencil = new Bitmap("RedPen.bmp");
private int amountOfPencils, amountOfPencilsLeft, currIndex, currAmount;
private System.Timers.Timer timer;
private Color currColor;
public event FinishedDrawing drawFinishedDeleg;
public PencilsUC()
{
// intializing things in the constructor...
this.timer = new System.Timers.Timer();
this.timer.Interval = 100;
this.timer.Elapsed += new ElapsedEventHandler(timer_Tick);
}
public void timer_Tick(object sender, EventArgs e)
{
// THE THING THAT MAKES THE CROSS THREAD-OPERATION: THE LINE INSIDE THE "if"
if (this.currColor == Color.Blue)
pencils[currIndex--].Image = bluePencil;
else
pencils[currIndex--].Image = redPencil;
this.currAmount--;
if (this.currAmount == 0)
{
this.timer.Stop();
if (this.drawFinishedDeleg != null)
this.drawFinishedDeleg.Invoke(this, new EventArgs());
}
}
public void fillPencils(Color c, int amount)
{
MessageBox.Show("Hello");
this.currColor = c;
this.currAmount = amount;
this.timer.Start();
}
}
}
(THE CROSS THREAD OPERATION HAPPENS INSIDE THE TIMER_TICK FUNCTION)
I used the windows forms timer at first but for some reason it didn't get to the tick-event function (timer.Start() was called but I put a message box in the tick function and it didnt get in there so I changed it - I saw some answers that said it was better)
I would love some help, I am sorry for the long post, I just wanted to be as clear as I can...
Thanks a lot in advance! :)

Use a Windows.Forms.Timer instead of a System.Timers.Timer. (You'll need to change the names of a few properties/events, i.e. Tick instead of Elapsed, but it's straightforward enough.)
The Timer in the Form's namespace marshals the Tick event into the UI thread, unlike the systems timer which executes the event in a thread pool thread.
If you really prefer to use the system's timer, then you can set the SynchronizingObject to have it marshall it's event to the UI thread:
timer.SynchronizingObject = this;
Note that the UserControl is a synchronizable object.

You need to .Invoke onto the main thread to change any controls.
Image image;
if (this.currColor == Color.Blue)
image = bluePencil;
else
image = redPencil;
this.Invoke(new MethodInvoker(() => pencils[currIndex--].Image = image));
The => is the syntax for a lambda (called anonymous method in other languages). Think about it as a one-line function.
() => pencils[currIndex--].Image = image
is the same as:
void SetImage(Image image, ref int currIndex) {
pencils[currIndex--].Image = image;
}
MethodInvoker provides a simple delegate that is used to invoke a method with a void parameter list

The easiest fix as you already made code would be to set SynchronizingObject of the Timer to Form, so timer would run on UI thread.

Related

C# WinForms forms timer not ticking inside of loop

I created a C# project, a WinForms App with a background class. The WinForms App class contains a single point and draws this point everytime you call the "Refresh()" Method. With a press on the spacebar you get the background class running. The background class provides a "run()" method this method calls a calculation Method a specific number of times (while loop). the calculation method then performs some calculations and adds the results to a stack and then starts a timer. This timer contains a draw method, that takes the data from the stack and tells the Form to print a the circle for every stack entry. (Its quite confusing to describe code is below and should be easy to understand)
Now I got to a quite strange problem I don't understand:(see sample code below)
In the background class when the while loop calls the calculation the calculation will be done but the time will not execute the draw method. But when you comment out the while loop start and end and instead press the spacebar manually multiple times everything works fine. Why is the code working without the loop and manually pressing multiple times but not with the while loop? And how can I fix it to get it working with the loop?
Steps to reproduce the problem:
Create a new WinForms App in visual studio, replace the Form1.cs with the code below and create a BackgroundRunner.cs class with the code below.
Then simply run the project and press the spacebar to get the background class running.
To get the code working:
Just comment out the while loop start and end and press the spacebar manually multiple times. (the circle shout move)
Additional:
Yep in this broken down example it looks weird to create two seperate classes and a forms timer but in the whole project I need to get it working this way.
Thanks in advance.
I've already googled and found solutions like the timer and UI need to be on the same thread etc. But I think both are on the same thread, because it works without the loop.
This is the Form1.cs class:
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace TestApp
{
public partial class Form1 : Form
{
private Point p;
private BackgroundRunner runner;
private int count = 0;
private int max = 10;
public Form1() {
InitializeComponent();
p = new Point(0, 0);
runner = new BackgroundRunner(this);
}
private void Form1_Load(object sender, EventArgs e) {
}
//Method to refresh the form (draws the single point)
override
protected void OnPaint(PaintEventArgs e) {
drawPoint(p, e.Graphics);
}
//Method to draw a point
private void drawPoint(Point p, Graphics g) {
Brush b = new SolidBrush(Color.Black);
g.FillEllipse(b, p.X, p.Y, 10, 10);
}
//when you press the space bar the runner will start
override
protected void OnKeyDown(KeyEventArgs e) {
if(e.KeyValue == 32) {
runner.run();
}
}
public int getCount() {
return count;
}
public int getMax() {
return max;
}
//sets point, refreshes the form and increases the count
public void setPoint(Point pnew) {
p = pnew;
Refresh();
count++;
}
}
}
And this is the BackgroundRunner.cs class:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace TestApp
{
class BackgroundRunner
{
private Form1 form;
private System.Windows.Forms.Timer timer;
private Stack<int> test;
private int max;
private int count;
public BackgroundRunner(Form1 formtemp) {
form = formtemp;
timer = new System.Windows.Forms.Timer();
timer.Interval = 100;
timer.Tick += drawMovement;
}
public void run() {
count = form.getCount();
max = form.getMax();
//Here happens the strange stuff:
//If you comment out the while loop start and end
//and press manually the space bar the circle will move
//from right to left an up to down.
//But if you use the while loop nothing will happen
//and the "drawMovement" Method will never be executed,
//because the message inside will never be written...
Console.WriteLine("Count: " + count + " Max: " + max);
while (count < max) {
Console.WriteLine("Calc Move");
calculateMovement();
count = form.getCount();
max = form.getMax();
Thread.Sleep(50);
}
}
//Just a method that adds data to the stack and then start the timer
private void calculateMovement() {
test = new Stack<int>(5);
test.Push(10);
test.Push(20);
test.Push(30);
test.Push(40);
test.Push(50);
timer.Start();
}
//Method that goes through the stack and updates
//the forms point incl refresh
private void drawMovement(object o, EventArgs e) {
Console.WriteLine("Draw Move");
if (test.Count <= 0) {
timer.Stop();
return;
}
int x = test.Pop();
int y = count;
form.setPoint(new System.Drawing.Point(x, y));
}
}
}
Never block the main thread where the message loop takes place.
The timer is triggered within the message dispathing, that is why your timer is not triggered while you are blocking the main thread by the loop and sleep.
Make the method async by changing the public void run() into public async void run()
Replace Threed.Sleep with await Task.Delay then the loop would work asynchronously.
This would probably throw Exceptions if your application targets .NET Framewok version 2.0 or later (surely), because it is not thread-safe.
To solve this, put all codes that access the UI controls (which could be simply where the exception is thrown from, just in case that you are not sure what they are.) into
form.Invoke(new Action(()=>{
//Statements to access the UI controls
}));
Correction
The await will return execution on the UI thread because of the SynchronizationContext it is posted to. So there won't be exception about crossthreading.
by J.vanLangen

Cross-thread operation not valid for invalidating graphics object

I'm trying to create graphics that will redraw every 500ms using a Timer, but I keep running into a cross-thread operation. Can somebody please tell me why this is happening?
Error:
Cross-thread operation not valid: Control 'GraphicsBox' accessed from a thread other than the thread it was created on.
I'm using WinForms, and have a PictureBox called "GraphicsBox" in the main form:
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Diagnostics;
using System.Threading;
namespace NamespaceName
{
public partial class FormName : Form
{
Graphics g;
public FormName()
{
InitializeComponent();
System.Timers.Timer t = new System.Timers.Timer();
t.Interval = 500;
t.Enabled = true;
t.Elapsed += (s, e) => this.GraphicsBox.Invalidate(true);
}
private void FormName_Load(object sender, EventArgs e)
{
this.GraphicsBox.Paint += new PaintEventHandler(OnPaint);
}
protected void OnPaint(object sender, PaintEventArgs e)
{
g = e.Graphics;
//Draw things
}
}
}
Is there any way I can fire the OnPaint event I have from the timer's 'tick' (or 'elapsed')? I believe that will do the trick. All I'm trying to do is redraw the graphics object, and I will change things in the code to cause it to be drawn differently.
The main problem here is that there are at least 3 classes named Timer and probably more (in different namespaces, but with different behaviours). You are using one that calls back on a worker thread, and UI controls don't like that due to thread affinity.
If you switch to System.Windows.Forms.Timer it will invoke the callback on the UI thread (presumably via sync-context, but I guess it might be implemented using the message loop directly). This is then not a cross-thread operation, and will work fine.
You're calling the GraphicsBox object on the wrong thread, System.Timers.Timer.Elapsed is called on a different (Background) thread.
You can either -
a) Switch to using System.Windows.Forms.Timer, which will run on the same thread as GraphicsBox
or
b) Quick and nasty -
t.Elapsed += (s, e) => this.Invoke(new MethodInvoker(delegate(){ this.GraphicsBox.Invalidate(true); }));

How do I access variables from a different thread?

Getting error: Cross-thread operation not valid: Control 'label1' accessed from a thread other than the thread it was created on.
Code:
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Threading;
using System.Windows.Forms;
namespace WindowsFormsApplication2
{
public partial class Form1 : Form
{
string CONNECTING = "Connecting to server...";
string GETTING_DATA = "Getting data...";
string CONNECT_FAIL = "Failed to connect!";
string CONNECT_SUCCESS = "Connection established!";
public Form1()
{
InitializeComponent();
}
private void Form1_Load(object sender, EventArgs e)
{
Thread t1 = new Thread(run);
t1.Start();
}
public void run() {
label1.Text = CONNECTING;
}
}
}
How do I properly fix this? I've tried using CheckForIllegalCrossThreadCalls = false; but that obviously causes errors.
I'd also like to know how I can stop the thread, since it can't be accessed anymore outside of that function.
Thanks in advance!
Try using BeginInvoke:
public void run()
{
label1.BeginInvoke(new Action(() =>
{
label1.Text = CONNECTING;
}));
}
Only the UI thread can update UI elements in a Windows Forms app. Other threads need to use BeginInvoke to update the UI.
ORGINAL: i assumed this was a WPF app and said to use this.Dispatcher, but Dispatcher isn't in Windows Forms apps.
Accessing a control from different threads
In WinForms App you can ony access directly a Control from the thread it was created.
To do such a task you will need to use InvokeRequired property of a control to see if you must use Invoke inorder to force a call of the action from the original thread.
A public method that might be accessed from any thread including the original would look like this:
public void run() {
if (label1.InvokeRequired) //Is this method being called from a different thread
this.Invoke(new MethodInvoker(()=> label1.Text = CONNECTING));
else //it's cool, this is the original thread, procceed
label1.Text = CONNECTING;
}
But if you are absolutly sure that run() method will be called only from the thread, consider not even checking if InvokeRequired and immediatly call Invoke
Further information: http://msdn.microsoft.com/en-us/library/ms171728(v=vs.80).aspx
Stopping a thread in progress
Simples is to use t1.Abort(); method of a Thread. This will throw and exception forcing it to stop where ever it was. this is great for threads that do not do any long processing so stopping it won't cause any problems.
If you do do proccesing in your thread, which means you can't just stop it in the middle then I suggest you to use a boolean that will indicate that the thread must cancel ASAP.
private bool isCancelRequired = false;
public void run() {
while(true) {
//do long processing..
if (isCancelRequired)
break;
}
}
More advanced methods: http://www.yoda.arachsys.com/csharp/threads/shutdown.shtml

Thread error in C# Windows Form

I have gotten this error:
An unhandled exception of type 'System.InvalidOperationException'
occurred in System.Windows.Forms.dll
Additional information: Cross-thread operation not valid: Control
'Redlight' accessed from a thread other than the thread it was created
on.
Redlight and Greenlight are pictureBoxes.
Basically, all I want it to be able to do is alternate between each picture every second.
I searched on this website for similar errors, I see it has to do with "Invoking", but I don't even know what that is, can someone enlighten me?
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
using System.Threading;
namespace EMCTool
{
public partial class EMCTool_MainForm : Form
{
bool offOn = false;
public EMCTool_MainForm()
{
InitializeComponent();
}
private void EMCTool_MainForm_Load(object sender, EventArgs e)
{
System.Threading.Timer timer = new System.Threading.Timer(new System.Threading.TimerCallback(timerCallback), null, 0, 1000);
}
private void timerCallback(object obj)
{
if (offOn == false)
{
Redlight.Show();
offOn = true;
}
else
{
Greenlight.Show();
offOn = false;
}
}
}
}
You get the Cross-thread error when you try to update a UI element from any thread it was not created on.
Controls in Windows Forms are bound to a specific thread and are not thread safe. Therefore, if you are calling a control's method from a different thread, you must use one of the control's invoke methods to marshal the call to the proper thread. This property can be used to determine if you must call an invoke method, which can be useful if you do not know what thread owns a control.
Refer here for more
Try this .This works fine for me
if (pictureBoxname.InvokeRequired)
pictureBoxname.Invoke(new MethodInvoker(delegate
{
//access picturebox here
}));
else
{
//access picturebox here
}
In WinForms projects better use the System.Windows.Forms.Timer as it calls the Tick event on the UI-thread automatically:
private System.Windows.Forms.Timer _timer;
private void EMCTool_MainForm_Load(object sender, EventArgs e)
{
_timer = new System.Windows.Forms.Timer { Interval = 1000 };
_timer.Tick += Timer_Tick;
_timer.Start();
}
private void Timer_Tick(object sender, EventArgs e)
{
if (offOn) {
Greenlight.Show();
} else {
Redlight.Show();
}
offOn = !offOn;
}
Alternative solution would be to use System.Timers.Timer which has SynchronizingObject property so set this, and it will work:
timer.SynchronizingObject = This
Or to use System.Windows.Forms.Timer as it won't raise exception (it raises Tick event on UI thread).

Update of Windows Form - C#

Explanation:
Structure: Windows form - three components: Text box, Text box Response and button.
Problem: I am moving motor with C# windows form: I am starting the motor and reversing
the direction of movement of motor with single button click with 10 second delay in the middle. i.e. I start the motor, have 10 sec delay and then reverse the motor. I want to display "Start" at the beginning and "End" at the end of the 10 second delay. I have tried using thread but it does not work. But I am only able to see "Finish" not "Start" in text box. The code is below:
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Threading;
namespace SampleThreadProgram
{
public partial class Form1 : Form
{
static EventWaitHandle _waitHandle = new AutoResetEvent(false);
delegate void SetTextCallback(string text);
void SetText(string text)
{
if (textBox.InvokeRequired)
{
SetTextCallback d = new SetTextCallback(SetText);
BeginInvoke(d, new object[] { text });
}
else
{
textBox.Text = text;
}
}
void UpdateTextBox(string message)
{
SetText(message);
_waitHandle.Set();
}
void Wait()
{
for (ulong i = 0; i < 10000; i++)
{
for (ulong j = 0; j < 100000; j++)
{
}
}
}
public Form1()
{
InitializeComponent();
}
private void Form1_Load(object sender, EventArgs e)
{
}
private void button1_Click(object sender, EventArgs e)
{
UpdateTextBox("Start");
_waitHandle.WaitOne();
Thread.Sleep(10000);
UpdateTextBox("Finish");
}
}
}
You should not use a big long for loop to make the computer wait for a while. Use Thread.Sleep at the very least.
You should use a BackgroundWorker to do what you're trying to do. Set the start text in the button click event, then start the background worker. You can have the DoWork event do some work (in this case sleeping) and use the WorkerCompleted event to update the UI.
The nice thing about using the background worker is that you don't need to worry about updating code form non-UI threads. In the button click event you can update the text of the textbox directly, and the BackGroundWorker thread will already ensure that the Completed event runs in the UI thread, so even there you can directly access UI controls. The BGW is specifically designed to make this exact case easier.
There's not enough time for the UI to update. Add an Application.DoEvents(); after the SetText(message); in UpdateTextBox.

Categories

Resources