Merge branch 'dan_stateless' into dan_latest

3 files changed, 59 insertions, 0 deletions

diff --git a/scripts/automation/trex_control_plane/doc/packet_generator/index.rst b/scripts/automation/trex_control_plane/doc/packet_generator/index.rst
new file mode 100755
index 00000000..ed1d460d
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/packet_generator/index.rst
@@ -0,0 +1,18 @@
+
+TRex Packet Builder
+-------------------
+The TRex Packet Generator is a module designed to generate single-packet and set its ranging options, later to be transmitted using TRex.
+
+The packet generator module does extensive usage with `dkpt <https://github.com/kbandla/dpkt>`_  python module to create packet headers.
+
+.. toctree::
+    :maxdepth: 4
+
+    packet_builder_code
+
+.. toctree::
+    :maxdepth: 0
+    :titlesonly:
+
+    examples
+    stream_export
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/packet_generator/packet_builder_code.rst b/scripts/automation/trex_control_plane/doc/packet_generator/packet_builder_code.rst
new file mode 100755
index 00000000..3a6e8d5f
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/packet_generator/packet_builder_code.rst
@@ -0,0 +1,12 @@
+

+CTRexPktBuilder class

+---------------------

+

+.. autoclass:: packet_builder.CTRexPktBuilder

+    :members:

+    :member-order: bysource

+

+Packet Builder Exceptions

+-------------------------

+

+For exceptions documentation see here: :exc:`Packet Builder Exceptions <packet_builder.CTRexPktBuilder.CPacketBuildException>`
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst b/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst
new file mode 100755
index 00000000..eb639f7c
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst
@@ -0,0 +1,29 @@
+

+Stream Export YAML syntax

+=========================

+

+In order to provide a fluent work-flow that utilize the best TRex user's time, an export-import mini language has been created.

+

+This enables a work-flow that supports saving and sharing a built packets and its scenarios, so that other tools

+(such as TRex Console) could use them.

+

+The TRex Packet Builder module supports (using ___ method) the export of built stream according to the format described below.

+

+Guidelines

+----------

+

+1. The YAML file can either contain Byte representation of the packet of refer to a .pcap file that contains it.

+2. The YAML file is similar as much as possible to the `add_stream method <http://trex-tgn.cisco.com/trex/doc/trex_rpc_server_spec.html#_add_stream>`_ of TRex RPC server spec, which defines the raw interaction with TRex server.

+3. Only packet binary data and VM instructions are to be saved. Any meta-data packet builder module used while creating the packet will be stripped out.

+

+Export Format

+-------------

+

+.. literalinclude:: export_format.yaml

+    :lines: 4-

+    :linenos:

+

+Example

+-------

+

+The following files snapshot represents each of the options (Binary/pcap) for the very same HTTP GET request packet.