Skip to content

Commit

Permalink
iox-eclipse-iceoryx#1560 Update Readme's and used headers
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 Feb 1, 2023
1 parent db36e1a commit e3bc947
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
24 changes: 12 additions & 12 deletions iceoryx_dust/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Compared to hoofs classes in `iceoryx_dust`, the difference is that the classes
There are a wide variety of building blocks
grouped together in categories or namespace, depending on where or how they are used.

| class/file | description |
|:---------------------:|:------------------------------------------------------------------------------------------------------------------------|
|`forward_list` | Heap and exception free, relocatable implementation of `std::forward_list` |
|`ObjectPool` | Container which stores raw objects without calling the ctor of the objects. |
|`FileReader` | Wrapper for opening files and reading them. |
|`MessageQueue` | Interface for Message Queues, see [ManPage mq_overview](https://www.man7.org/linux/man-pages/man7/mq_overview.7.html). |
|`SignalWatcher` | Batteries included signal handling with polling and optional blocking wait for `SIGINT` and `SIGTERM`. |
|`NamedPipe` | Shared memory based ipc channel. Mainly a `UnixDomainSocket` replacement on Windows. |
|`relocatable_ptr` | |
|`static_storage` | Untyped aligned static storage. |
|`convert` | | Converting a number into a string is easy, converting it back can be hard. You can use functions like `strtoll` but you still have to handle errors like under- and overflow, or converting invalid strings into number. Here we abstract all the error handling so that you can convert strings into numbers safely. |
|`serialization` | | Implements a simple serialization concept for classes based on the idea presented here [ISOCPP serialization](https://isocpp.org/wiki/faq/serialization#serialize-text-format). |
| class/file | description |
|:---------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|`forward_list` | Heap and exception free, relocatable implementation of `std::forward_list` |
|`ObjectPool` | Container which stores raw objects without calling the ctor of the objects. |
|`FileReader` | Wrapper for opening files and reading them. |
|`MessageQueue` | Interface for Message Queues, see [ManPage mq_overview](https://www.man7.org/linux/man-pages/man7/mq_overview.7.html). |
|`SignalWatcher` | Batteries included signal handling with polling and optional blocking wait for `SIGINT` and `SIGTERM`. |
|`NamedPipe` | Shared memory based ipc channel. Mainly a `UnixDomainSocket` replacement on Windows. |
|`relocatable_ptr` | |
|`static_storage` | Untyped aligned static storage. |
|`convert` | Converting a number into a string is easy, converting it back can be hard. You can use functions like `strtoll` but you still have to handle errors like under- and overflow, or converting invalid strings into number. Here we abstract all the error handling so that you can convert strings into numbers safely. |
|`serialization` | Implements a simple serialization concept for classes based on the idea presented here [ISOCPP serialization](https://isocpp.org/wiki/faq/serialization#serialize-text-format). |
8 changes: 5 additions & 3 deletions iceoryx_hoofs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,11 @@ The module structure is a logical grouping. It is replicated for `concurrent` an

| class | internal | description |
|:---------------------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|`helplets` | | Implementations of [C++ Core Guideline](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) concepts like `not_null` are contained here. Additionally, we are providing some types to verify preconditions at compile time. | |
|`system_configuration` | i | Collection of free functions which acquire system information like the page-size. |
|`UniqueId` | i | Monotonic increasing IDs within a process. |
|`helplets` | | Implementations of [C++ Core Guideline](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) concepts like `not_null` are contained here. Additionally, we are providing some types to verify preconditions at compile time. |
|`system_configuration` | i | Collection of free functions which acquire system information like the page-size. |
|`UniqueId` | i | Monotonic increasing IDs within a process. |
|`into` | i | |
|`pageSize` | i | |

### Primitives (primitives)

Expand Down
1 change: 0 additions & 1 deletion tools/scripts/used-headers.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ atomic
bitset
cassert
chrono
climits
cmath
cpptoml.h
csignal
Expand Down

0 comments on commit e3bc947

Please sign in to comment.