TimeSortedSched Element Documentation
- NAME
- SYNOPSIS
- DESCRIPTION
- NOTES
- EXAMPLES
- SEE ALSO
- COMMENTS

This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.

TimeSortedSched Element Documentation

NAME

TimeSortedSched -- Click element; merge sorted packet streams by timestamp

SYNOPSIS

TimeSortedSched(KEYWORDS)

Ports: one output, zero or more inputs
Processing: pull
Package: analysis (core)

TimeSortedSched responds to pull requests by returning the chronologically next packet pulled from its inputs, determined by packet timestamps. TimeSortedSched listens for notification from its inputs to avoid useless pulls, and provides notification for its output. Keyword arguments are:

STOP: Boolean. If true, stop the driver when there are no packets available (and the upstream notifiers indicate that no packets will become available soon). Default is false.

NOTES

TimeSortedSched is a notifier signal, active iff any of the upstream notifiers are active.

EXAMPLES

This example merges multiple tcpdump(1) files into a single, time-sorted stream, and stops the driver when all the files are exhausted.

  tss :: TimeSortedSched(STOP true);
  FromDump(FILE1) -> [0] tss;
  FromDump(FILE2) -> [1] tss;
  FromDump(FILE3) -> [2] tss;
  // ...
  tss -> ...;

COMMENTS