doc/man/babeltrace2-filter.utils.muxer.7.txt

   1 = babeltrace2-filter.utils.muxer(7)
   2 :manpagetype: component class
   3 :revdate: 14 September 2019
   4
   5
   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             +-----------------+
  27 ----
  28
  29 include::common-see-babeltrace2-intro.txt[]
  30
  31 A compcls:filter.utils.muxer message iterator does not alter the
  32 messages it consumes: it only sorts them.
  33
  34 The message iterator creates one upstream message iterator per connected
  35 input port.
  36
  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.
  42
  43
  44 == PORTS
  45
  46 ----
  47 +-----------------+
  48 | flt.utils.muxer |
  49 |                 |
  50 @ in0         out @
  51 @ ...             |
  52 +-----------------+
  53 ----
  54
  55
  56 === Input
  57
  58 `inN`, where `N` is a decimal integer starting at 0::
  59     Input port on which a compcls:filter.utils.muxer message iterator
  60     creates an upstream message iterator to consumes messages from.
  61 +
  62 When the component is initialized, its only input port is
  63 `in0`. When you connect the `in0` port, the component creates
  64 the `in1` input port, and so on.
  65 +
  66 In other words, a compcls:filter.utils.muxer component always has an
  67 available input port.
  68
  69
  70 === Output
  71
  72 `out`::
  73     Single output port.
  74
  75
  76 include::common-footer.txt[]
  77
  78
  79 == SEE ALSO
  80
  81 man:babeltrace2-intro(7),
  82 man:babeltrace2-plugin-utils(7)