Skip to content

Commit

Permalink
doc: added examples
Browse files Browse the repository at this point in the history
  • Loading branch information
aoeldemann committed Nov 23, 2019
1 parent 0ce1c46 commit 0df91fa
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
########
Examples
########

Trace Replay
------------

`Source Code`__

This example measurement application replays a constant-bit-rate network trace (10 Gbps, 64 bytes packets) on all four interfaces of the network tester simultaneously.

.. _Trace Replay: https://github.com/aoeldemann/fluent10g/tree/master/examples/trace_replay
__ Trace Replay_

Trace Capture
-------------

`Source Code`__

This measurement application captures arriving network traffic on all four network interfaces for 10 seconds.
It then writes the recorded data into four separate output network traces and prints out the number of packets captured on each interface.
Each packet is accurately timestamped upon reception at the network interface, the resulting PCAP trace contains nanosecond resolution timestamps.

.. _Trace Capture: https://github.com/aoeldemann/fluent10g/tree/master/examples/packet_capture
__ Trace Capture_

Latency Measurements
--------------------

`Source Code`__

This measurement application replays a trace file (constant-bit-rate traffic, 10 Gbps, 64 byte packets) on network interface 0.
It expects the traffic to arrive back at the network tester at interface 1.
Therefore, make sure that these two ports are either directly looped-back or configure your attached device-under-test accordingly.
The network tester captures the latencies (= time from packet transmission until reception back at the tester) for every packet and writes the values to an output text file after the measurement (6.4 ns time resolution).

.. _Latency: https://github.com/aoeldemann/fluent10g/tree/master/examples/latency
__ Latency_


1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ as fast as possible and have you perform your measurements in no time.
gettingstarted
preparation
installation
examples

.. _NetFPGA-SUME: https://netfpga.org

0 comments on commit 0df91fa

Please sign in to comment.