Skip to content

Commit 2ed509b

Browse files
mossmaurice-apexaimossmaurice-apexai
committed
iox-#1295 Add two new articles about extensions and cmd line args of RouDi
1 parent 7ac79d1 commit 2ed509b

File tree

2 files changed

+21
-12
lines changed

2 files changed

+21
-12
lines changed

‎doc/website/advanced/available-bindings-extensions.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Available bindings and extensions
2+
3+
The following bindings and extensions are available for iceoryx:
4+
5+
| Name | Description | Link |
6+
|---------------------|-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
7+
| DDS gateway | Gateway to the DDS protocol using [Cyclone DDS](https://cyclonedds.io/) or [FastDDS](https://github.com/eProsima/Fast-DDS) | [https://github.com/eclipse-iceoryx/iceoryx-gateway-dds](https://github.com/eclipse-iceoryx/iceoryx-gateway-dd) |
8+
| Rust binding | Binding to use the C++ version of iceoryx in Rust projects | [https://github.com/eclipse-iceoryx/iceoryx-rs](https://github.com/eclipse-iceoryx/iceoryx-rs) |
9+
| ara::com binding | Binding to use iceoryx in [AUTOSAR Adaptive](https://www.autosar.org/standards/adaptive-platform/) projects | [https://github.com/eclipse-iceoryx/iceoryx-automotive-soa](https://github.com/eclipse-iceoryx/iceoryx-automotive-soa) |

‎doc/website/advanced/roudi-command-line-arguments.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
To view the available command line options for RouDi call `$ICEORYX_ROOT/build/iox-roudi --help`.
44

5-
| Short | Long | Parameter | Explanation |
6-
|-------|---------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7-
| -h | --help | None | Prints the available options |
8-
| -v | --version | None | Prints the version string |
9-
| -d | --domain-id | Unsigned integer | Sets the domain id. No communication can happen between different domains. Experimental feature! |
10-
| -u | --unique-roudi-id | Unsigned integer | Sets the unique Roudi identifier |
11-
| -m | --monitoring-mode | String (on, off) | Enables or disables the process alive monitoring feature. If enable RouDi terminates and kills unresponsive process. |
12-
| -l | --log-level | String (off, fatal, error, warning, info, debug, trace) | Set the log level. Default log level is 'info'. |
13-
| -x | --compatibility | String (off, major, minor, patch, commitId, buildDate) | Sets the compatibility check level between application and RouDi. Default is 'patch'. This can be useful if old apps are build against and old iceoryx version. Use with care! |
14-
| -t | --termination-delay | Unsigned integer | Sets the delay in seconds before RouDi sends SIGTERM to running applications at shutdown. Default is '0' |
15-
| -k | --kill-delay | Unsigned integer | Sets the delay in seconds before RouDi sends SIGKILL to application which did not respond to the initial SIGTERM signal. Default is '45'. |
16-
| -c | --config-file | String (Filesystem path to a config in YAML format) | Sets the config file. If option is not given, fallbacks in descending order: 1. /etc/iceoryx/roudi_config.toml 2. hard-coded config |
5+
| Short | Long | Parameter | Explanation |
6+
|-------|---------------------|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7+
| -h | --help | None | Prints the available options |
8+
| -v | --version | None | Prints the version string |
9+
| -d | --domain-id | Unsigned integer | Sets the domain id. No communication can happen between different domains. Experimental feature! |
10+
| -u | --unique-roudi-id | Unsigned integer | Sets the unique RouDi identifier |
11+
| -m | --monitoring-mode | String (on, off) | Enables or disables the process alive monitoring feature. If enable RouDi terminates and kills unresponsive process. |
12+
| -l | --log-level | String (off, fatal, error, warning, info, debug, trace) | Set the log level. Default log level is 'info'. |
13+
| -x | --compatibility | String (off, major, minor, patch, commitId, buildDate) | Sets the compatibility check level between application and RouDi. Default is 'patch'. This can be useful if old apps are build against and old iceoryx version. Use with care! |
14+
| -t | --termination-delay | Unsigned integer | Sets the delay in seconds before RouDi sends SIGTERM to running applications at shutdown. Default is '0'. |
15+
| -k | --kill-delay | Unsigned integer | Sets the delay in seconds before RouDi sends SIGKILL to application which did not respond to the initial SIGTERM signal. Default is '45'. |
16+
| -c | --config-file | String (Absolute filesystem path to a config in YAML format) | Sets the config file. If option is not given, fallbacks in descending order: 1. /etc/iceoryx/roudi_config.toml 2. hard-coded config. See [configuration guide](configuration-guide.md#dynamic-configuration) for information on the format. |

0 commit comments

Comments
 (0)