Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-15 17:41:45 +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

8
examples/multiple-transports/README.md
View File

@@ -3,10 +3,10 @@ Multiple Transports example
This example demonstrates use of multiple transports (zeromq/nanomsg/shmem) within the same topology and/or device. It is a simple topology consisting of two samplers and a sink. The devices are connected via 3 channels:
![Multiple Transports example](../../../docs/images/fairmq-ex-multiple-transports.png?raw=true "Multiple Transports example")
![Multiple Transports example](../../docs/images/example_multiple_transports.png?raw=true "Multiple Transports example")
Each device has main transport that it uses. By default it is ZeroMQ, and can be overriden via the `--transport` cmd option. The device will initialize additional transports if any of the channels have them configured (e.g. via the JSON file, see `ex-multiple-transports.json`).
Each device has main transport that it uses. By default it is ZeroMQ, and can be overriden via the `--transport` cmd option. The device will initialize additional transports if any of the channels have them configured (e.g. as an option to `--channel-config`).
In this example sampler1 and sink are started with `--transport shmem`, making shared memory their main transport, sampler2 with `--transport nanomsg`. Additionally, the ack channel is configured to use zeromq as its transport via the JSON configuration.
In this example sampler1 and sink are started with `--transport shmem`, making shared memory their main transport, sampler2 with `--transport nanomsg`. Additionally, the ack channel is configured to use zeromq as its transport.
The main two things that a transport does is transfer of data and allocation of memory for the messages. By default, new messages are created via the main device transport. If a message has been created with one transport and is to be transferred with another, it has to be copied into a new message of the target transport. This happens automatically behind the scenes. To avoid this copy the device can create messages via `NewMessageFor(const string& channelName, int subChannelIndex, ...)` method, that creates the messages via the transport of the given channel (check sampler1 and sink for an example).
The main two things that a transport does is transfer of data and allocation of memory for the messages. By default, new messages are created via the main device transport. If a message has been created with one transport and is to be transferred with another, it has to be copied into a new message of the target transport. This happens automatically behind the scenes. To avoid this copy the device can create messages via `NewMessageFor(const string& channelName, int subChannelIndex, ...)` method, that creates the messages via the transport of the given channel (check sampler1 and sink for an example) or as the channel directly to create a message.

84
examples/multiple-transports/ex-multiple-transports.json
View File

@@ -1,84 +0,0 @@
{
"fairMQOptions": {
"devices": [
{
"id": "sampler1",
"channels": [
{
"name": "data1",
"sockets": [
{
"type": "push",
"method": "bind",
"address": "tcp://127.0.0.1:5555"
}
]
},
{
"name": "ack",
"transport": "zeromq",
"sockets": [
{
"type": "sub",
"method": "bind",
"address": "tcp://127.0.0.1:5557"
}
]
}
]
},
{
"id": "sampler2",
"channels": [
{
"name": "data2",
"sockets": [
{
"type": "push",
"method": "bind",
"address": "tcp://127.0.0.1:5556"
}
]
}
]
},
{
"id": "sink1",
"channels": [
{
"name": "data1",
"sockets": [
{
"type": "pull",
"method": "connect",
"address": "tcp://127.0.0.1:5555"
}
]
},
{
"name": "data2",
"transport": "nanomsg",
"sockets": [
{
"type": "pull",
"method": "connect",
"address": "tcp://127.0.0.1:5556"
}
]
},
{
"name": "ack",
"transport": "zeromq",
"sockets": [
{
"type": "pub",
"method": "connect",
"address": "tcp://127.0.0.1:5557"
}
]
}
]
}
]
}
}