-
Notifications
You must be signed in to change notification settings - Fork 678
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add article on threading #2568
Open
tznind
wants to merge
4
commits into
gui-cs:v1_develop
Choose a base branch
from
tznind:threading-docs
base: v1_develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add article on threading #2568
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Threading | ||
It is common for a developer to run one or more background tasks on a separate | ||
`Thread` (or `Task`). For example to periodically fetch data. If you want to | ||
make changes to any `View` from this background task, you must issue the change | ||
on the main Terminal.Gui UI thread. | ||
|
||
**Updates to the user interface should only be performed on the main UI thread.** | ||
|
||
This is required to prevent errors, for example if Terminal.Gui is trying to | ||
render a `View` while its contents are actively being changed from another Thread. | ||
|
||
## How to issue call to main thread | ||
To run an operation on the main thread from a background task use: | ||
|
||
```csharp | ||
Application.MainLoop.Invoke(()=>{/* Your Code Here*/}); | ||
``` | ||
|
||
For example: | ||
|
||
```csharp | ||
using Terminal.Gui; | ||
|
||
Application.Init(); | ||
|
||
var w = new Window(); | ||
|
||
// Start a background task | ||
Task.Run(() => | ||
{ | ||
while(true) | ||
{ | ||
// Do some computation | ||
Task.Delay(30).Wait(); | ||
|
||
// Issue a call to the main thread | ||
Application.MainLoop.Invoke(() => | ||
{ | ||
//This code resolves in the main UI thread | ||
w.RemoveAll(); | ||
w.Add(new Label("Time is:" + DateTime.Now)); | ||
|
||
w.SetNeedsDisplay(); | ||
}); | ||
} | ||
}); | ||
|
||
Application.Run(w); | ||
|
||
Application.Shutdown(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use the "infinitive form" in API docs instead of the "impersonal you". The infinitive form of a verb is its basic, uninflected form, typically preceded by the word "to" in English. For example, "to eat," "to play," or "to learn." By using the infinitive form, the sentence becomes more concise and focuses on the action itself.
This would be rewritten as "To make changes to a
View
from a background task, issue the change on the main Terminal.Gui Thread thread."Miguel tends to write using the "impersonal you" form, so a lot of the old docs still use this. But I've worked hard to rid most API docs of it. Thanks.