Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-17 02:21:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update example READMEs

Browse Source
This commit is contained in:
Alexey Rybalchenko
2018-04-30 15:14:50 +02:00
parent ae0fa58acd
commit bcc38b03c5
11 changed files with 85 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
examples/1-1/README.md
View File

@@ -1,10 +1,10 @@
Example 1: Sampler -> Sink
===============
1-1: Sampler -> Sink
====================
A simple topology of two devices - **Sampler** and **Sink**. **Sampler** sends data to **Sink** via the **PUSH-PULL** pattern.
`runExample1Sampler.cxx` and `runExample1Sink.cxx` configure and run the devices in their main function.
`runSampler.cxx` and `runSink.cxx` configure and run the devices.
The executables take two required command line parameters: `--id` and `--mq-config`. The value of `--id` should be a unique identifier and the value for `--mq-config` a path to a config file. The config file for this example is `ex1-sampler-sink.json` and it contains configuration for the communication channels of the devices. The mapping between a specific device and the configuration (which can contain multiple devices) is done based on the **id**.
The executables take two command line parameters: `--id` and `--channel-config`. The value of `--id` should be a unique identifier and the value for `--channel-config` is the configuration of the communication channel. .
For this and the following example, all the commands needed to start the device are contained in the startFairMQExN.sh script (that can also be used for starting the example).
For this and the following example, all the commands needed to start the device are contained in the `fairmq-start-ex-*.sh` script (that can also be used for starting the example).