v2.08 version
authorHanoh Haim <[email protected]>
Thu, 18 Aug 2016 19:22:02 +0000 (22:22 +0300)
committerHanoh Haim <[email protected]>
Thu, 18 Aug 2016 19:22:02 +0000 (22:22 +0300)
release_notes.asciidoc
trex_book.asciidoc
trex_index.asciidoc
trex_rpc_server_spec.asciidoc
trex_scapy_rpc_server-docinfo.html [new file with mode: 0644]
trex_scapy_rpc_server.asciidoc
ws_main.py

index 3238241..039e044 100755 (executable)
@@ -25,8 +25,8 @@ endif::backend-docbook[]
 
 == Release 2.08  ==
 
-* Scapy server for GUI packet crafting, see  link:trex_scapy_rpc_server.html[trex_scapy_rpc_server]
-* Client.start Python API supports Core mask  - significantly improve the Stateless performance. TBD- Itay to update the pointer here  
+* Scapy JSON-RPC server for GUI packet crafting, see  link:trex_scapy_rpc_server.html[trex_scapy_rpc_server]
+* Client.start Python API supports Core mask  - significantly improve the Stateless performance. link:cp_stl_docs/_modules/trex_stl_lib/trex_stl_client.html#STLClient.start[start API],  *TBD*- Itay to update the pointer here  
 * Upgrade the ./dpdk_setup_ports.py script. It simplifies the way to create first time *optimized* config file (/etc/trex_cfg.yaml)
 
 [source,bash]
@@ -35,6 +35,8 @@ $sudo ./dpdk_setup_ports.py script -t            # show the list of ports
 $sudo ./dpdk_setup_ports.py  -c  03:00.0 03:00.1 # create optimum /etc/trex_cfg.yaml file 
 ----
 
+*Yaroslav* TBD 
+
 * Basic Cisco VIC functionality works now. Advanced Stateless/Stateful functionality is still not supported.
 
 === fix issues: ===
index 806e269..0c621d8 100755 (executable)
@@ -227,6 +227,7 @@ NOTE: Purchase the 10Gb/sec SFP+ separately. Cisco would be fine with TRex (but
 ==== Supported versions
 
 Supported Linux versions:
+
 * Fedora 20-23, 64-bit kernel (not 32-bit)
 * Ubuntu 14.04.1 LTS, 64-bit kernel (not 32-bit)
 * Ubuntu 16.xx LTS, 64-bit kernel (not 32-bit) 
index 158119c..b2f3b1f 100644 (file)
@@ -80,7 +80,9 @@ link:../client_gui/[stateful GUI]
 |=================
 | Description  |    Name 
 | Stateless server RPC specification    | 
-link:trex_rpc_server_spec.html[server.html] 
+link:trex_rpc_server_spec.html[stl_rpc_server.html] 
+| Scapy server RPC specification    | 
+link:trex_scapy_rpc_server.html[scapy_rpc_spec.html] 
 | How to build    | 
 link:https://github.com/cisco-system-traffic-generator/trex-core/wiki[Wiki]
 |=================
index 9e81c53..7d01611 100755 (executable)
@@ -83,14 +83,13 @@ http://zeromq.org/intro:read-the-manual
 The RPC reprensentation protocol is JSON RPC v2.0.
 Every request and response will be encoded in a JSON RPC v2.0 format.
 
-{zwsp} +
-
+{zwsp}+
 For more info on JSON RPC v2.0 spec please refer to:
-{zwsp} +
+{zwsp}+
 
 http://www.jsonrpc.org/specification
 
-{zwsp} +
+{zwsp}+
 
 Later on in the document we will describe all the supported commands.
 
diff --git a/trex_scapy_rpc_server-docinfo.html b/trex_scapy_rpc_server-docinfo.html
new file mode 100644 (file)
index 0000000..6fb66a5
--- /dev/null
@@ -0,0 +1,6 @@
+
+
+
+
+
+
index bf771d4..5c46272 100755 (executable)
@@ -9,18 +9,7 @@ The TRex Scapy RPC Server
 :local_web_server_url: csi-wiki-01:8181/trex
 :toclevels: 4
 
-++++
-<script>
-  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
-  ga('create', 'UA-75220362-1', 'auto');
-  ga('send', 'pageview');
-
-</script>
-++++
+include::trex_ga.asciidoc[]
 
 == Change log
 
@@ -35,9 +24,7 @@ The TRex Scapy RPC Server
 
 == Audience of this document 
 
-Anyone who wants to create,edit and assemble packets for TRex
-
-
+TRex GUI guys
 
 == Scapy RPC Server - Overview
 Scapy Server is implemented following the link:http://www.jsonrpc.org/specification[JSON-RPC 2.0 specification], +
@@ -46,7 +33,6 @@ The server operates on a Request-Response basis *over ZMQ*, and does not support
 
 Read more about ZMQ link:http://zguide.zeromq.org/page:all[here]
 
-
 image::images/Scapy_JSON_rpc_server.png[title="Scapy JSON RPC Server",align="left",width=800, link="images/Scapy_JSON_rpc_server.png"]
 
 === Error Codes
@@ -78,7 +64,7 @@ Has the following structure: +
 
 (field name, field type, default value) +
 
-[example]
+.Example
 ====
 *Example:* +
 this is the 'dst' field for the 'Ether' protocol
@@ -99,7 +85,7 @@ Has the following structure: +
 [field offset (within the layer), field size] +
 
 
-[example]
+.Example
 ====
 *Example:* +
 This is the 'src' field for the 'IP' protocol: +
@@ -117,7 +103,7 @@ Has the following structure: +
  +
 
 
-[example]
+.Example
 ====
 *Example:* +
 This is the Offsets Dictionary for the IP layer: +
@@ -154,7 +140,7 @@ Each entry in this data base has the following format: +
 'Protocol Name' : 'Protocol Field Description' +
  +
 
-[example]
+.Example
 ====
 *Example*: +
 [source,bash]
index 930cbc3..2a534df 100755 (executable)
@@ -915,6 +915,8 @@ def build(bld):
     bld(rule=convert_to_html_toc_book,
         source='trex_rpc_server_spec.asciidoc waf.css', target='trex_rpc_server_spec.html',scan=ascii_doc_scan);
 
+    bld(rule=convert_to_html_toc_book,
+        source='trex_scapy_rpc_server.asciidoc waf.css', target='trex_scapy_rpc_server.html',scan=ascii_doc_scan);
 
     bld(rule='${ASCIIDOC}   -a stylesheet=${SRC[1].abspath()} -a  icons=true -a toc2 -a max-width=55em  -o ${TGT} ${SRC[0].abspath()}',
         source='vm_doc.asciidoc waf.css', target='vm_doc.html', scan=ascii_doc_scan)
@@ -922,8 +924,6 @@ def build(bld):
     bld(rule='${ASCIIDOC}   -a stylesheet=${SRC[1].abspath()} -a  icons=true -a toc2 -a max-width=55em  -o ${TGT} ${SRC[0].abspath()}',
         source='packet_builder_yaml.asciidoc waf.css', target='packet_builder_yaml.html', scan=ascii_doc_scan)
 
-    bld(rule='${ASCIIDOC}   -a stylesheet=${SRC[1].abspath()} -a  icons=true -a toc2 -a max-width=55em  -o ${TGT} ${SRC[0].abspath()}',
-        source='trex_scapy_rpc_server.asciidoc waf.css', target='trex_scapy_rpc_server.html', scan=ascii_doc_scan)
 
     bld(rule='${ASCIIDOC}   -a stylesheet=${SRC[1].abspath()} -a  icons=true -a toc2 -a max-width=55em  -o ${TGT} ${SRC[0].abspath()}',
         source='trex_control_plane_design_phase1.asciidoc waf.css', target='trex_control_plane_design_phase1.html', scan=ascii_doc_scan)