Skip to content

Commit

Permalink
github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@GIC-de
GIC-de committed Feb 20, 2024
1 parent 85f5fbb commit edfefa0
Show file tree
Hide file tree
Showing 105 changed files with 6,809 additions and 17,374 deletions.
Binary file added docs/_images/bbl_flows.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 15 additions & 25 deletions docs/_sources/api/sessions.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,45 +10,35 @@
+-----------------------------------+----------------------------------------------------------------------+
| **sessions-pending** | | List all sessions not established. |
+-----------------------------------+----------------------------------------------------------------------+
| **session-traffic** | | Display session traffic statistics. |
+-----------------------------------+----------------------------------------------------------------------+
| **session-traffic-start** | | Enable/start session traffic. |
| | | |
| **session-start** | | Start/stop sessions. |
| **session-stop** | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` (ignored if session-id is present) |
+-----------------------------------+----------------------------------------------------------------------+
| **session-traffic-stop** | | Disable/stop session traffic. |
| **session-restart** | | Restart sessions. |
| | | The argument ``reconnect-delay`` is only applicable in combination |
| | | with session reconnect enabled in the configuration. This argument |
| | | delays the session reconnect by the defined amount of seconds. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **session-traffic-reset** | | Reset all session traffic streams. |
| | | ``session-group-id`` (ignored if session-id is present) |
| | | ``reconnect-delay`` |
+-----------------------------------+----------------------------------------------------------------------+
| **session-streams** | | Display session streams. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` Mandatory |
+-----------------------------------+----------------------------------------------------------------------+
| **session-start** | | Start session manually. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` |
| **session-traffic** | | Display session traffic statistics. |
+-----------------------------------+----------------------------------------------------------------------+
| **session-stop** | | Stop sessions manually. |
| | | |
| **session-traffic-start** | | This command can be used to start or stop session-traffic flows. |
| **session-traffic-stop** | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` |
| | | ``session-group-id`` (ignored if session-id is present) |
| | | ``direction`` (upstream/downstream/both) |
+-----------------------------------+----------------------------------------------------------------------+
| **session-restart** | | Restart sessions manually. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` |
| | | ``reconnect-delay`` |
| **session-traffic-reset** | | Reset all session traffic streams. |
+-----------------------------------+----------------------------------------------------------------------+

The argument ``reconnect-delay`` is only applicable in combination with
session reconnect enabled in the configuration. This argument delays the
session reconnect by the defined amount of seconds.
37 changes: 16 additions & 21 deletions docs/_sources/api/streams.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,31 @@
| | | ``flow-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **stream-summary** | | Display stream/flow summary information. |
+-----------------------------------+----------------------------------------------------------------------+
| **stream-traffic-start** | | Enable/start traffic streams bound to sessions. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **stream-traffic-stop** | | Disable/stop traffic streams bound to sessions. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` |
| | | ``name`` stream name |
| | | ``interface`` TX interface name |
| | | ``direction`` [both(default), upstream, downstream] |
+-----------------------------------+----------------------------------------------------------------------+
| **stream-reset** | | Reset all traffic streams. |
+-----------------------------------+----------------------------------------------------------------------+
| **stream-start** | | Enable/start traffic streams/flows. This command also applies to |
| | | RAW stream which are not bould to sessions. |
| **stream-start** | | This command can be used to start or stop traffic stream flows. |
| **stream-stop** | | This command applies to all flows except session-traffic and |
| **stream-stop-verfied** | | multicast. If you provide a specific ``flow-id`` as an argument, |
| | | other arguments are ignored. In this particular case, you can also |
| | | start and stop session-traffic and multicast. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` |
| | | ``flow-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **stream-stop** | | Disable/stop traffic streams/flows. This command also applies to |
| | | RAW stream which are not bould to sessions. |
| | | The command **stream-stop-verfied** works similar to |
| | | **stream-stop** but only verfied streams will be stopped. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
| | | ``session-group-id`` |
| | | ``flow-id`` |
| | | ``session-id`` |
| | | ``session-group-id`` (ignored if session-id is present) |
| | | ``name`` stream name |
| | | ``interface`` TX interface name |
| | | ``direction`` [both(default), upstream, downstream] |
+-----------------------------------+----------------------------------------------------------------------+
| **streams-pending** | | List flow-id of all pending (not verfied) traffic streams. |
| **streams-pending** | | List flow-id of all pending (not verified) traffic streams. |
+-----------------------------------+----------------------------------------------------------------------+
15 changes: 8 additions & 7 deletions docs/_sources/api/traffic.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
+-----------------------------------+----------------------------------------------------------------------+
| Command | Description |
+===================================+======================================================================+
| **traffic-start** | | Start all traffic (session and streams). |
+-----------------------------------+----------------------------------------------------------------------+
| **traffic-stop** | | Stop all traffic (session and streams). |
+-----------------------------------+----------------------------------------------------------------------+
| **multicast-traffic-start** | | Start multicast traffic. |
+-----------------------------------+----------------------------------------------------------------------+
| **multicast-traffic-stop** | | Stop multicast traffic. |
| **traffic-start** | | This command can be used to start or stop all traffic globally. |
| **traffic-stop** | | This command does not alter the current state of a traffic stream. |
| | | In example, if a stream has not been started or has been stopped, |
| | | it can't be started with this command. Instead, this command acts |
| | | as a global block to control the transmission of traffic streams. |
+-----------------------------------+----------------------------------------------------------------------+
| **multicast-traffic-start** | | This command can be used to start or stop all multicast traffic. |
| **multicast-traffic-stop** | | |
+-----------------------------------+----------------------------------------------------------------------+
8 changes: 6 additions & 2 deletions docs/_sources/configuration/interfaces.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,18 @@
| | | maximum number of packets in the ring buffer. |
| | | Default: 4096 |
+-----------------------------------+----------------------------------------------------------------------+
| **io-burst** | | IO burst (ring size). |
| | | Default: 256 |
+-----------------------------------+----------------------------------------------------------------------+
| **qdisc-bypass** | | Bypass the kernel's qdisc layer. |
| | | It's currently not recommended to change the default (issue #206)! |
| | | Default: true |
+-----------------------------------+----------------------------------------------------------------------+
| **tx-interval** | | TX polling interval in milliseconds. |
| | | Default: 1.0 Range: 0.0001 to 1000 |
| | | Default: 0.1 Range: 0.0001 to 1000 |
+-----------------------------------+----------------------------------------------------------------------+
| **rx-interval** | | RX polling interval in milliseconds. |
| | | Default: 1.0 Range: 0.0001 to 1000 |
| | | Default: 0.1 Range: 0.0001 to 1000 |
+-----------------------------------+----------------------------------------------------------------------+
| **tx-threads** | | Number of TX threads per interface link. |
| | | Default: 0 (main thread) |
Expand Down
2 changes: 2 additions & 0 deletions docs/_sources/configuration/interfaces_links.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ for interface links referenced by interface functions.
+-----------------------------------+----------------------------------------------------------------------+
| **io-mode** | | Overwrite the IO mode. |
+-----------------------------------+----------------------------------------------------------------------+
| **io-burst** | | Overwrite the IO burst. |
+-----------------------------------+----------------------------------------------------------------------+
| **io-slots** | | Overwrite the IO slots (ring size). |
+-----------------------------------+----------------------------------------------------------------------+
| **io-slots-tx** | | Overwrite the TX IO slots (ring size). |
Expand Down
5 changes: 3 additions & 2 deletions docs/_sources/configuration/lns.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,6 @@
| **lcp-padding** | | Add fixed padding to LCP packets send from LNS. |
| | | Default: 0 Range: 0 - 65535 |
+-------------------------------------------+---------------------------------------------------------------------+


| **client-auth-id** | | Add optional check based on client-auth-id to support multiple |
| | | LNS server configurations with the same IP address. |
+-------------------------------------------+---------------------------------------------------------------------+
Loading

0 comments on commit edfefa0

Please sign in to comment.