testprotocols 0.3.0__tar.gz → 0.4.1__tar.gz

{testprotocols-0.3.0/src/testprotocols.egg-info → testprotocols-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testprotocols
-Version: 0.3.0
+Version: 0.4.1
 Summary: Common Test Resource Layer — capability and device protocols for telco testing.
 Author-email: Alottabits <rjvisser@alottabits.com>
 Maintainer-email: Alottabits <rjvisser@alottabits.com>

{testprotocols-0.3.0 → testprotocols-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "testprotocols"
-version = "0.3.0"
+version = "0.4.1"
 description = "Common Test Resource Layer — capability and device protocols for telco testing."
 requires-python = ">=3.12"
 dependencies = []

{testprotocols-0.3.0 → testprotocols-0.4.1}/src/testprotocols/iperf_client.py

@@ -25,9 +25,32 @@ class IperfClient(Protocol):
         time: int = 10,
         client_port: int | None = None,
         udp_only: bool | None = None,
+        reverse: bool = False,
+        omit_s: int | None = None,
+        json_output: bool = False,
+        window: str | None = None,
     ) -> tuple[int, str]:
         """Start an iperf traffic sender towards *host* on *traffic_port*.
 
+        Typed option parameters (each defaults to "absent": no flag emitted):
+
+        - ``reverse``: iperf3 reverse mode (``-R``) — the listening receiver
+          transmits; the sender still initiates the connection.
+        - ``omit_s``: skip the first N seconds (``-O <n>``, the TCP slow-start
+          ramp); omitted seconds extend the wall clock and are excluded from
+          the end-of-test summary.
+        - ``json_output``: machine-readable output (``--json``).
+        - ``window``: pin the socket buffer (``-w <size>``, e.g. ``"8M"``) on
+          BOTH ends — iperf3 forwards it to the server in the test-parameter
+          exchange. Pinning disables OS receive/send autotuning; the effective
+          value is capped by ``net.core.rmem_max``/``wmem_max`` (NOT
+          ``tcp_rmem``/``tcp_wmem``), so the host must be provisioned
+          accordingly.
+
+        ``direction`` is DEPRECATED: a raw CLI fragment appended verbatim
+        after the typed flags. Kept as an escape hatch only; use the typed
+        parameters instead.
+
         Returns a tuple of (pid, log_file_path).
         """
         ...

{testprotocols-0.3.0 → testprotocols-0.4.1/src/testprotocols.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testprotocols
-Version: 0.3.0
+Version: 0.4.1
 Summary: Common Test Resource Layer — capability and device protocols for telco testing.
 Author-email: Alottabits <rjvisser@alottabits.com>
 Maintainer-email: Alottabits <rjvisser@alottabits.com>