doc/man/babeltrace2-sink.utils.dummy.7.txt

   1 = babeltrace2-sink.utils.dummy(7)
   2 :manpagetype: component class
   3 :revdate: 14 September 2019
   4
   5
   6 == NAME
   7
   8 babeltrace2-sink.utils.dummy - Babeltrace 2's dummy sink component class
   9
  10
  11 == DESCRIPTION
  12
  13 A Babeltrace~2 compcls:sink.utils.dummy component consumes messages
  14 and discards them (does absolutely nothing with them).
  15
  16 ----
  17             +------------------+
  18             | sink.utils.dummy |
  19             |                  |
  20 Messages -->@ in               |
  21             +------------------+
  22 ----
  23
  24 include::common-see-babeltrace2-intro.txt[]
  25
  26 A compcls:sink.utils.dummy sink component can be useful to run a trace
  27 processing graph with no sink side effect, for example to perform
  28 benchmarks. Prefer a compcls:sink.utils.dummy component class for such
  29 tasks to, for example, a compcls:sink.text.pretty component and sending
  30 its output to `/dev/null`, as a compcls:sink.text.pretty component still
  31 performs formatting operations.
  32
  33
  34 == PORTS
  35
  36 ----
  37 +------------------+
  38 | sink.utils.dummy |
  39 |                  |
  40 @ in               |
  41 +------------------+
  42 ----
  43
  44
  45 === Input
  46
  47 `in`::
  48     Single input port.
  49
  50
  51 include::common-footer.txt[]
  52
  53
  54 == SEE ALSO
  55
  56 man:babeltrace2-intro(7),
  57 man:babeltrace2-plugin-utils(7)