Skip to content

Commit

Permalink
timeline: Added manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
shramov committed Nov 24, 2024
1 parent 6dfe4c0 commit 4285ea8
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/channel/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ mansources = [
'stream-client.rst',
'tcp.rst',
'timeit.rst',
'timeline.rst',
'timer.rst',
'udp.rst',
'yaml.rst',
Expand Down
33 changes: 33 additions & 0 deletions src/channel/timeline.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
tll-channel-timeline
====================

:Manual Section: 7
:Manual Group: TLL
:Subtitle: Delay messages for period between time fields

Synopsis
--------

``timeline+CHILD://PARAMS...;speed=<float>``


Description
-----------

Prefix channel that delays messages according to their ``time`` fields. Its purpose is to
emulate real world load by replaying recorded data where simple rate limiter is not sufficient.
Delay is calculated as ``(m[n+1].time - m[n].time) / speed`` starting from first message.

Init parameters
~~~~~~~~~~~~~~~

``speed=<float>`` default ``1.0``, speed of data stream compared to ``time`` fields, larger values
means that delay is smaller.

See also
--------

``tll-channel-common(7)``

..
vim: sts=4 sw=4 et tw=100

0 comments on commit 4285ea8

Please sign in to comment.