KOKINIO - MANAGER
Edit File: tcp_metrics.rst
.. LINENO 2 .. SPDX-License-Identifier: GPL-2.0 .. NOTE: This document was auto-generated. .. _netlink-tcp_metrics: ============================================ Family ``tcp_metrics`` netlink specification ============================================ .. contents:: :depth: 3 ------- Summary ------- Management interface for TCP metrics. ---------- Operations ---------- .. LINENO 131 .. _tcp_metrics-operation-get: get === Retrieve metrics. :attribute-set: :ref:`tcp_metrics-attribute-set-tcp-metrics` :dont-validate: ['strict', 'dump'] :do: .. LINENO 138 **request** :attributes: [``addr-ipv4``, ``addr-ipv6``, ``saddr-ipv4``, ``saddr-ipv6``] **reply** :attributes: [``addr-ipv4``, ``addr-ipv6``, ``saddr-ipv4``, ``saddr-ipv6``, ``age``, ``vals``, ``fopen-mss``, ``fopen-syn-drops``, ``fopen-syn-drop-ts``, ``fopen-cookie``] :dump: .. LINENO 157 **reply** :attributes: [``addr-ipv4``, ``addr-ipv6``, ``saddr-ipv4``, ``saddr-ipv6``, ``age``, ``vals``, ``fopen-mss``, ``fopen-syn-drops``, ``fopen-syn-drop-ts``, ``fopen-cookie``] .. LINENO 160 .. _tcp_metrics-operation-del: del === Delete metrics. :attribute-set: :ref:`tcp_metrics-attribute-set-tcp-metrics` :dont-validate: ['strict', 'dump'] :flags: [``admin-perm``] :do: .. LINENO 168 **request** :attributes: [``addr-ipv4``, ``addr-ipv6``, ``saddr-ipv4``, ``saddr-ipv6``] ----------- Definitions ----------- .. LINENO 16 .. _tcp_metrics-definition-tcp-fastopen-cookie-max: tcp-fastopen-cookie-max ======================= :type: const :value: 16 -------------- Attribute sets -------------- .. _tcp_metrics-attribute-set-tcp-metrics: tcp-metrics =========== .. LINENO 26 addr-ipv4 (``u32``) ~~~~~~~~~~~~~~~~~~~ :byte-order: big-endian :display-hint: ipv4 .. LINENO 31 addr-ipv6 (``binary``) ~~~~~~~~~~~~~~~~~~~~~~ :byte-order: big-endian :display-hint: ipv6 .. LINENO 38 age (``u64``) ~~~~~~~~~~~~~ .. LINENO 41 tw-tsval (``u32``) ~~~~~~~~~~~~~~~~~~ :doc: unused .. LINENO 45 tw-ts-stamp (``s32``) ~~~~~~~~~~~~~~~~~~~~~ :doc: unused .. LINENO 49 vals (``nest``) ~~~~~~~~~~~~~~~ :nested-attributes: :ref:`tcp_metrics-attribute-set-metrics` .. LINENO 53 fopen-mss (``u16``) ~~~~~~~~~~~~~~~~~~~ .. LINENO 56 fopen-syn-drops (``u16``) ~~~~~~~~~~~~~~~~~~~~~~~~~ .. LINENO 59 fopen-syn-drop-ts (``u64``) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. LINENO 62 fopen-cookie (``binary``) ~~~~~~~~~~~~~~~~~~~~~~~~~ .. LINENO 67 saddr-ipv4 (``u32``) ~~~~~~~~~~~~~~~~~~~~ :byte-order: big-endian :display-hint: ipv4 .. LINENO 72 saddr-ipv6 (``binary``) ~~~~~~~~~~~~~~~~~~~~~~~ :byte-order: big-endian :display-hint: ipv6 .. LINENO 79 pad (``pad``) ~~~~~~~~~~~~~ .. _tcp_metrics-attribute-set-metrics: metrics ======= Attributes with metrics. Note that the values here do not match the TCP_METRIC_* defines in the kernel, because kernel defines are off-by one (e.g. rtt is defined as enum 0, while netlink carries attribute type 1). .. LINENO 92 rtt (``u32``) ~~~~~~~~~~~~~ :doc: Round Trip Time (RTT), in msecs with 3 bits fractional (left-shift by 3 to get the msec value). .. LINENO 98 rttvar (``u32``) ~~~~~~~~~~~~~~~~ :doc: Round Trip Time VARiance (RTT), in msecs with 2 bits fractional (left-shift by 2 to get the msec value). .. LINENO 104 ssthresh (``u32``) ~~~~~~~~~~~~~~~~~~ :doc: Slow Start THRESHold. .. LINENO 108 cwnd (``u32``) ~~~~~~~~~~~~~~ :doc: Congestion Window. .. LINENO 112 reodering (``u32``) ~~~~~~~~~~~~~~~~~~~ :doc: Reodering metric. .. LINENO 116 rtt-us (``u32``) ~~~~~~~~~~~~~~~~ :doc: Round Trip Time (RTT), in usecs, with 3 bits fractional (left-shift by 3 to get the msec value). .. LINENO 122 rttvar-us (``u32``) ~~~~~~~~~~~~~~~~~~~ :doc: Round Trip Time (RTT), in usecs, with 2 bits fractional (left-shift by 3 to get the msec value).