Skip to content

Commit

Permalink
iox-eclipse-iceoryx#1295 (DROP ME) Rework optional/expected and QoS a…
Browse files Browse the repository at this point in the history
…rticle
  • Loading branch information
mossmaurice committed Jan 30, 2025
1 parent 46b2953 commit e45c672
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ result = iox::nullopt;
```

For a complete list of available functions see
[`optional.hpp`](../../../iceoryx_hoofs/vocabulary/include/iox/optional.hpp).
[`optional.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_hoofs/vocabulary/include/iox/optional.hpp).


## Expected
Expand All @@ -80,7 +80,7 @@ the 'either monad'. It is usually used to pass a value of type `T` or an error t
error type.

For more information on how it is used for error handling see
[error-handling.md](../../design/error-handling.md).
[error-handling.md](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/doc/design/error-handling.md).

Assume we have `E` as an error type, then we can create a value

Expand Down Expand Up @@ -121,7 +121,7 @@ result.and_then(handleValue).or_else(handleError);
There are more convenience functions such as `value_or` which provides the value or an alternative specified by the
user. These can be found in
[`expected.hpp`](../../../iceoryx_hoofs/vocabulary/include/iox/expected.hpp).
[`expected.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_hoofs/vocabulary/include/iox/expected.hpp).
Note that when we move an `expected`, the origin contains a moved `T` or `E`, depending on the content before the move.
This reflects the behavior of moving the content out of the `iox::expected` as in
Expand Down
2 changes: 1 addition & 1 deletion doc/website/concepts/qos-policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The three most important settings are:
2. Multiple publishers after the publisher called `stopOffer()` or is removed
The last n samples will never be received since they vanished. An arbitrary number of samples or nothing is received.

For more information about the options see the corresponding example [`iceoptions`](../../../iceoryx_examples/iceoptions/README.md).
For more information about the options see the corresponding example [`iceoptions`](../examples/iceoptions.md).

!!! info
If the `PublisherOptions::historyCapacity` is larger than `SubscriberOptions::queueCapacity` and blocking behaviour
Expand Down

0 comments on commit e45c672

Please sign in to comment.