Skip to content

Commit

Permalink
iox-eclipse-iceoryx#1295 Sync Readme with code
Browse files Browse the repository at this point in the history 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
  • Loading branch information
@mossmaurice
mossmaurice committed Sep 22, 2022
1 parent ba45f90 commit 17951ef
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions iceoryx_hoofs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class should be used.
| class | internal | description |
|:----------------------------------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|`unique_ptr` | | Provides a heap-less unique_ptr implementation, unlike the STL |
|`relative_ptr` | | Pointer which can be stored in shared memory |
|`RelativePointer` | | Pointer which can be stored in shared memory |
|`ScopeGuard` | | This is an abstraction of the C++ RAII idiom. Sometimes you have constructs where you would like to perform a certain task on creation and then again when they are getting out of scope, this is where `ScopeGuard` comes in. It is like a `std::lock_guard` or a `std::shared_ptr` but more generic. |
|`scoped_static` | | Helper function to limit lifetime of static or global variables to a scope |
|`static_storage` | i | Untyped aligned static storage. |
Expand Down Expand Up @@ -112,7 +112,7 @@ class should be used.
|`LoFFLi` | i | Lock-free LIFO based index manager (lock-free free list). One building block of our memory manager. After construction it contains the indices {0 ... n} which you can acquire and release. |
|`SoFi` | i | Single producer, single consumer lock-free safely overflowing FiFo (SoFi). |
|`ResizeableLockFreeQueue` | | Resizeable variant of the `LockfreeQueue` |
|`variant_queue` | | A queue which wraps multiple variants of Queues (FiFo, SoFi, ResizeableLockFreeQueue) |
|`VariantQueue` | | A queue which wraps multiple variants of Queues (FiFo, SoFi, ResizeableLockFreeQueue) |
|`UnixDomainSocket` | i | Interface for unix domain sockets. |
|`IpcChannel` | i | Helper types used by the `MessageQueue`and the `UnixDomainSocket`. |

Expand All @@ -133,7 +133,8 @@ class should be used.
|`PeriodicTask` | i | Periodically executes a callable specified by the template parameter in a configurable time interval. |
|`smart_lock` | i | Creates arbitrary thread-safe constructs which then can be used like smart pointers. If some STL type should be thread safe use the smart_lock to create the thread safe version in one line. Based on some ideas presented in [Wrapping C++ Member Function Calls](https://stroustrup.com/wrapper.pdf) |
|`mutex` | i | Mutex interface, see [ManPage pthread_mutex_lock](https://man7.org/linux/man-pages/man3/pthread_mutex_lock.3p.html). |
|`Semaphore` | | Semaphore interface, see [ManPage sem_overview](https://man7.org/linux/man-pages/man7/sem_overview.7.html) |
|`UnnamedSemaphore` | | Unamed semaphore interface, see [ManPage sem_overview](https://man7.org/linux/man-pages/man7/sem_overview.7.html) |
|`NamedSemaphore` | | Named semaphore interface, see [ManPage sem_overview](https://man7.org/linux/man-pages/man7/sem_overview.7.html) |
|`thread` | | Heap-less replacement for `std::thread`. |

### Generalized design patterns
Expand Down

0 comments on commit 17951ef

Please sign in to comment.