Skip to content

Commit

Permalink
apps.test: document Synth.
Browse files Browse the repository at this point in the history
  • Loading branch information
eugeneia committed Apr 8, 2016
1 parent f076907 commit 3719753
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions src/apps/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,38 @@ keys are defined:

*Optional.* If this key is `true` packets from `rx` that do not match the next
packet from `comparator` are ignored. The default is `false`.


## Synth (apps.test.synth)

The `Synth` app generates synthetic packets with Ethernet headers and
alternating payload sizes. On each breath it fills each attached output link
with new packets.

DIAGRAM: Synth
+-------+
| |
| *---- (any)
| |
| Synth *---- (any)
| |
| *---- (any)
| |
+-------+

### Configuration

The `Synth` app accepts a table as its configuration argument. The following
keys are defined:

— Key **src**

— Key **dst**

Source and destination MAC addresses in human readable from. The default is
`"00:00:00:00:00:00"`.

— Key **sizes**

An array of numbers designating the packet payload sizes. The default is
`{64}`.

0 comments on commit 3719753

Please sign in to comment.