Skip to content

Commit

Permalink
iox-#743 Adapt links in overview.md
Browse files Browse the repository at this point in the history
Signed-off-by: Marika Lehmann <[email protected]>
  • Loading branch information
FerdinandSpitzschnueffler committed Mar 11, 2022
1 parent 16947db commit ad37027
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/website/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ iox::popo::Subscriber<CounterTopic> subscriber({"Group", "Instance", "CounterTop
```
Now we can use the subscriber to receive data. For simplicity, we assume that we periodically check for new data. It
is also possible to explicitly wait for data using the [WaitSet](https://github.com/eclipse-iceoryx/iceoryx/tree/master/iceoryx_examples/waitset)
or the [Listener](https://github.com/eclipse-iceoryx/iceoryx/blob/master/doc/design/listener.md). The code to
is also possible to explicitly wait for data using the [WaitSet](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/waitset)
or the [Listener](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/doc/design/listener.md). The code to
receive the data is the same, the only difference is the way we wake up before checking for data.
```cpp
Expand Down Expand Up @@ -326,12 +326,12 @@ For more information about the Listener see our
## API

The API is offered in two languages, C++ and C. Detailed information can be found in the
[C++ example](https://github.com/eclipse-iceoryx/iceoryx/blob/master/iceoryx_examples/icedelivery) and
[C example](https://github.com/eclipse-iceoryx/iceoryx/blob/master/iceoryx_examples/icedelivery_in_c).
[C++ example](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_examples/icedelivery) and
[C example](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_examples/icedelivery_in_c).

Many parts of the C++ API follow a functional programming approach which is less error-prone. This requires using
the monadic types `cxx::expected` and `cxx::optional` which are introduced
[here](https://github.com/eclipse-iceoryx/iceoryx/blob/master/doc/website/concepts/how-optional-and-error-values-are-returned-in-iceoryx.md).
[here](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/doc/website/concepts/how-optional-and-error-values-are-returned-in-iceoryx.md).

With the C++ API, we distinguish between the `typed API` and the `untyped API`. In the typed API, the underlying
data type is made apparent by typed pointers or references to some data type T (often a template parameter). This allows
Expand Down

0 comments on commit ad37027

Please sign in to comment.