README.md

QoS Manager
====

This program implements methods provided by the `qos` object on U-Bus. This is done by calling `libqos` provided by `easy-soc-libs`.

So far, the only method implemented is:
- `get_status  : {"ifname":"String","qid":"Integer"}`
    - `ifname`: interface name for which we want to get the QoS statistics
    - `qid`: the TX queue ID for which we want to get the statistics. Optional argument: if not provided, the statistics of all queues for a given interface are returned.

    The response given by this method is a JSON-formatted dump as such:
    ```
    {
        "queues": [
                {
                "qid": 1,
                "iface": "eth1",
                "tx_packets": 1146,
                "tx_bytes": 447762,
                "tx_dropped_packets": 0,
                "tx_dropped_bytes": 0
            },
        ]
    }
    ```

Implementation choices
===
This has been modeled after what the `tmctl` command prints on the DG400. As such, the returned structure could be made somewhat more generic
if some other hardware would be supported after that.

TODO
===

- Reimplement the `reload` method provided by existing scripts
- Integration in the OS build