Commit | Line | Data |
---|---|---|
a8be4294 | 1 | babeltrace2-filter.utils.muxer(7) |
0659f3af PP |
2 | ================================ |
3 | :manpagetype: component class | |
4 | :revdate: 5 October 2017 | |
5 | ||
6 | ||
7 | NAME | |
8 | ---- | |
a8be4294 | 9 | babeltrace2-filter.utils.muxer - Babeltrace's notification multiplexer |
0659f3af PP |
10 | filter component class |
11 | ||
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
15 | The Babeltrace compcls:filter.utils.muxer component class, provided by | |
a8be4294 | 16 | the man:babeltrace2-plugin-utils(7) plugin, once instantiated, |
0659f3af PP |
17 | multiplexes the notifications that it receives from one or more input |
18 | ports into a linear sequence of events ordered by time on its output | |
19 | port. | |
20 | ||
21 | A compcls:filter.utils.muxer component does not alter the notifications | |
22 | it receives: it only sorts them. | |
23 | ||
24 | A compcls:filter.utils.muxer component can only work on notifications in | |
25 | which the clock value with the highest priority has an absolute clock | |
26 | class. You can use the param:assume-absolute-clock-classes parameter to | |
27 | make the component assume that all clock classes are absolute. In this | |
28 | case, you must ensure that, when more than one clock class exists, they | |
29 | are correlatable. | |
30 | ||
31 | ||
32 | INITIALIZATION PARAMETERS | |
33 | ------------------------- | |
34 | The following parameters are optional. | |
35 | ||
36 | param:assume-absolute-clock-classes=`yes` (boolean):: | |
37 | Assume that all clock classes are absolute. | |
38 | ||
39 | ||
40 | PORTS | |
41 | ----- | |
42 | Input | |
43 | ~~~~~ | |
44 | `inN`, where `N` is a decimal integer starting at 0:: | |
45 | Input port from which the component receives notifications to | |
46 | multiplex. | |
47 | + | |
48 | When you create the component, its only input port is | |
49 | `in0`. When you connect the `in0` port, the component creates | |
50 | the `in1` input port, and so on. If you disconnect an input port, | |
51 | the component does not create a new input port: the disconnected | |
52 | input port is now available for a new connection. | |
53 | + | |
54 | In other words, a compcls:filter.utils.muxer component always makes sure | |
55 | that it has at least one available input port. | |
56 | ||
57 | ||
58 | Output | |
59 | ~~~~~~ | |
60 | `out`:: | |
61 | Single output port to which the component sends the | |
62 | sorted notifications. | |
63 | ||
64 | ||
65 | QUERY OBJECTS | |
66 | ------------- | |
67 | This component class has no objects to query. | |
68 | ||
69 | ||
70 | ENVIRONMENT VARIABLES | |
71 | --------------------- | |
72 | include::common-common-compat-env.txt[] | |
73 | ||
74 | `BABELTRACE_FLT_UTILS_MUXER_LOG_LEVEL`:: | |
75 | Component class's log level. The available values are the | |
a8be4294 MJ |
76 | same as for the manopt:babeltrace2(1):--log-level option of |
77 | man:babeltrace2(1). | |
0659f3af PP |
78 | |
79 | ||
80 | include::common-footer.txt[] | |
81 | ||
82 | ||
83 | SEE ALSO | |
84 | -------- | |
a8be4294 MJ |
85 | man:babeltrace2-plugin-utils(7), |
86 | man:babeltrace2-intro(7) |