| 1 | babeltrace-sink.utils.dummy(7) |
| 2 | ============================== |
| 3 | :manpagetype: component class |
| 4 | :revdate: 5 October 2017 |
| 5 | |
| 6 | |
| 7 | NAME |
| 8 | ---- |
| 9 | babeltrace-sink.utils.dummy - Babeltrace's dummy sink component class |
| 10 | |
| 11 | |
| 12 | DESCRIPTION |
| 13 | ----------- |
| 14 | The Babeltrace compcls:sink.utils.dummy component class, provided by the |
| 15 | man:babeltrace-plugin-utils(7) plugin, once instantiated, receives |
| 16 | notifications from its input port and discards them (does absolutely |
| 17 | nothing with them). |
| 18 | |
| 19 | A compcls:sink.utils.dummy sink component can be useful to run a trace |
| 20 | processing graph with no sink side effect, for example to perform |
| 21 | benchmarks. You should prefer this component class for such tasks |
| 22 | instead of, for example, using a compcls:sink.text.pretty component and |
| 23 | sending its output to `/dev/null`, as a compcls:sink.text.pretty |
| 24 | component still performs pretty-printing operations. |
| 25 | |
| 26 | |
| 27 | INITIALIZATION PARAMETERS |
| 28 | ------------------------- |
| 29 | This component class has no initialization parameters. |
| 30 | |
| 31 | |
| 32 | PORTS |
| 33 | ----- |
| 34 | Input |
| 35 | ~~~~~ |
| 36 | `in`:: |
| 37 | Single input port from which the component receives the |
| 38 | notifications to discard. |
| 39 | |
| 40 | |
| 41 | QUERY OBJECTS |
| 42 | ------------- |
| 43 | This component class has no objects to query. |
| 44 | |
| 45 | |
| 46 | ENVIRONMENT VARIABLES |
| 47 | --------------------- |
| 48 | include::common-common-compat-env.txt[] |
| 49 | |
| 50 | |
| 51 | include::common-footer.txt[] |
| 52 | |
| 53 | |
| 54 | SEE ALSO |
| 55 | -------- |
| 56 | man:babeltrace-plugin-utils(7), |
| 57 | man:babeltrace-intro(7) |