Skip to content

Commit

Permalink
fixing README
Browse files Browse the repository at this point in the history
  • Loading branch information
solariun committed Jan 7, 2022
1 parent 9a1c44b commit 6cf5d8a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ Version 1.1.0 release

What is AtomicX? AtomicX is a general purpose **cooperative** thread lib for embedded applications (single core or confined within other RTOS) that allows you partition your application "context" (since core execution) into several controlled context using cooperative thread. So far here nothing out of the ordinary, right? Lets think again:

## Version 1.1.0

* `finish()` method will be call every time `run()` is returned, this allow special cases like eventual threads to self-destroy itself, otherwise the object would be only a memory leak.... see examples on `main.cpp`

* `SmartLock` RAII compliance, allow lock or shared lock to be auto release on object destruction.

* **IMPORTANT** Now Notifications (Wait/Notify) can be timedout. if Tick based time is given, the waiting procedure will only stay blocked during it. (NO SPIN LOCK, REAL STATE BLOCK)
* **IMPORTANT** `LookForWaitings` block for timeout time will a wait for specific refVar/tag is available, otherwise timeout, can be used sync wait and notify availability
* **IMPORTANT** Now `Wait/Notify` `Tags`, used to give meaning/channel to a notification can be se to "all tags" if `Tag` is zero, otherwise it will respect refVar/Tag

## Version 1.0.0


Expand Down Expand Up @@ -63,16 +73,6 @@ What is AtomicX? AtomicX is a general purpose **cooperative** thread lib for emb
* Since it will be provided by the developer, it gives the possibility to use external clocks, hardware sleep or lower consumptions and fine tune power and resource usages.

* If not specialization is done, the source code will use a simple and non-deterministic loop cycle to count ticks.

## Version 1.1.0

* `finish()` method will be call every time `run()` is returned, this allow special cases like eventual threads to self-destroy itself, otherwise the object would be only a memory leak.... see examples on `main.cpp`

* `SmartLock` RAII compliance, allow lock or shared lock to be auto release on object destruction.

* **IMPORTANT** Now Notifications (Wait/Notify) can be timedout. if Tick based time is given, the waiting procedure will only stay blocked during it. (NO SPIN LOCK, REAL STATE BLOCK)
* **IMPORTANT** `LookForWaitings` block for timeout time will a wait for specific refVar/tag is available, otherwise timeout, can be used sync wait and notify availability
* **IMPORTANT** Now `Wait/Notify` `Tags`, used to give meaning/channel to a notification can be se to "all tags" if `Tag` is zero, otherwise it will respect refVar/Tag


``` C++
Expand Down

0 comments on commit 6cf5d8a

Please sign in to comment.