Skip to content

Clarify thread safety in IoT libraries #48264

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.

Sign up for GitHub

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

Merged
meaghanlewis merged 3 commits into from
Sep 10, 2025
Merged

Clarify thread safety in IoT libraries #48264

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4c11f2
Clarify thread safety in IoT libraries
felixcollins Sep 4, 2025
4d09a02
Update thread safety explanation in intro.md
felixcollins Sep 7, 2025
9f77eb4
Update docs/iot/intro.md
felixcollins Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/iot/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@
- [Max7219 - LED Matrix driver](https://github.com/dotnet/iot/tree/main/src/devices/Max7219)
- [RGBLedMatrix - RGB LED Matrix](https://github.com/dotnet/iot/tree/main/src/devices/RGBLedMatrix)

## A word on threads

Check failure on line 49 in docs/iot/intro.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines 

docs/iot/intro.md:49 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## A word on threads"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
By convention objects in these libraries are **not** designed to be **thread safe**. This means that all access to an object should be done from the thread it was created on. Be aware when using the libraries that they may run other threads internally for monitoring hardware and firing events. If you subscribe to an event it will likely be fired from a different thread.

Check failure on line 50 in docs/iot/intro.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces 

docs/iot/intro.md:50:373 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md

## Supported operating systems

`System.Device.Gpio` is supported on any operating system that supports .NET, including most versions of Linux that support ARM/ARM64 and Windows 10 IoT Core.
Expand Down
Loading