Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 2.54 KB

README.md

File metadata and controls

42 lines (34 loc) · 2.54 KB
Raw

Howto build the examples

To build the examples you can use the cmake configuration which is provided in iceoryx_meta.

cmake -Bbuild -Hiceoryx_meta -Dexamples=ON # by default the examples are always build
cd build 
make

To run an example switch into the iceoryx_examples directory which can be found in our build directory. Then select your example and follow the instructions from the examples readme.

cd build/iceoryx_examples/
cd someExample
./runExampleCode

List of all examples

Example Description Level
callbacks Implement callbacks which are triggered by events. Intermediate
callbacks_in_c The C version of the callbacks example. Intermediate
icedelivery You are new to iceoryx then take a look at this example which demonstrates the basics of iceoryx by sending data from one process to another process. Beginner
icedelivery_in_c Shows the same use case as the ice delivery example but with the iceoryx C API Beginner
ice_multi_publisher Shows how multiple publishers can be used to publish on the same topic. Intermediate
waitset Explaining the structure, usage and ideas behind the WaitSet. Intermediate
waitset_in_c The C example of our WaitSet. Intermediate
singleprocess Iceoryx can also be used for inter thread communication when you would like to run everything in a single process. Intermediate
iceperf A benchmark application which measures the latency of an IPC transmission between two applications. Advanced
icecrystal Demonstrates the usage of the iceoryx introspection client. Advanced

How to add a new example

  1. Add the example in the "List of all examples" in this markdown file
  2. Add the example folder name into the EXAMPLES=${EXAMPLES} ... array in ./tools/iceoryx_build_test.sh
  3. Add an add_subdirectory directive into iceoryx_meta/CMakeLists.txt in the if(EXAMPLES) section.
  4. Add the example in the file with the corresponding level in doc/website/getting-started/examples/LEVEL-examples.md