README.md

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
icecrystal	Demonstrates the usage of the iceoryx introspection client.
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.
icedelivery_on_c	Shows the same use case as the ice delivery example but with the iceoryx C API
iceperf	A benchmark application which measures the latency of an IPC transmission between two applications.
singleprocess	Iceoryx can also be used for inter thread communication when you would like to run everything in a single process.
ice_multi_publisher	Shows how multiple publishers can be used to publish on the same topic.
waitset	Explaining the structure, usage and ideas behind the WaitSet.
waitset_on_c	The C example of our WaitSet.