Commit | Line | Data |
---|---|---|
e70712b3 | 1 | = babeltrace2-filter.utils.muxer(7) |
0659f3af | 2 | :manpagetype: component class |
e70712b3 | 3 | :revdate: 14 September 2019 |
0659f3af PP |
4 | |
5 | ||
e70712b3 PP |
6 | == NAME |
7 | ||
8 | babeltrace2-filter.utils.muxer - Babeltrace 2's message muxer filter | |
9 | component class | |
10 | ||
11 | ||
12 | == DESCRIPTION | |
13 | ||
14 | A Babeltrace~2 compcls:filter.utils.muxer message iterator muxes | |
15 | the messages that it consumes from one or more upstream message | |
16 | iterators into a linear sequence of messages ordered by time. | |
17 | ||
18 | ---- | |
19 | +-----------------+ | |
20 | | flt.utils.muxer | | |
21 | | | | |
22 | Messages -->@ in0 out @--> Sorted messages | |
23 | Messages -->@ in1 | | |
24 | Messages -->@ in2 | | |
25 | @ in3 | | |
26 | +-----------------+ | |
0659f3af | 27 | ---- |
0659f3af | 28 | |
e70712b3 | 29 | include::common-see-babeltrace2-intro.txt[] |
0659f3af | 30 | |
e70712b3 PP |
31 | A compcls:filter.utils.muxer message iterator does not alter the |
32 | messages it consumes: it only sorts them. | |
0659f3af | 33 | |
e70712b3 PP |
34 | The message iterator creates one upstream message iterator per connected |
35 | input port. | |
0659f3af | 36 | |
e70712b3 PP |
37 | NOTE: To support muxing messages with different default clock classes, |
38 | the message iterator converts the message times to nanoseconds from the | |
39 | common origin (Unix epoch, for example). This means that the resulting | |
40 | message sequence could be incorrect if one or more clock classes have a | |
41 | frequency which is greater than 1~GHz. | |
0659f3af PP |
42 | |
43 | ||
e70712b3 PP |
44 | == PORTS |
45 | ||
46 | ---- | |
47 | +-----------------+ | |
48 | | flt.utils.muxer | | |
49 | | | | |
50 | @ in0 out @ | |
51 | @ ... | | |
52 | +-----------------+ | |
53 | ---- | |
0659f3af | 54 | |
0659f3af | 55 | |
e70712b3 | 56 | === Input |
0659f3af | 57 | |
0659f3af | 58 | `inN`, where `N` is a decimal integer starting at 0:: |
e70712b3 PP |
59 | Input port on which a compcls:filter.utils.muxer message iterator |
60 | creates an upstream message iterator to consumes messages from. | |
0659f3af | 61 | + |
e70712b3 | 62 | When the component is initialized, its only input port is |
0659f3af | 63 | `in0`. When you connect the `in0` port, the component creates |
e70712b3 | 64 | the `in1` input port, and so on. |
0659f3af | 65 | + |
e70712b3 PP |
66 | In other words, a compcls:filter.utils.muxer component always has an |
67 | available input port. | |
0659f3af PP |
68 | |
69 | ||
e70712b3 | 70 | === Output |
0659f3af | 71 | |
e70712b3 PP |
72 | `out`:: |
73 | Single output port. | |
0659f3af PP |
74 | |
75 | ||
76 | include::common-footer.txt[] | |
77 | ||
78 | ||
e70712b3 PP |
79 | == SEE ALSO |
80 | ||
81 | man:babeltrace2-intro(7), | |
82 | man:babeltrace2-plugin-utils(7) |