From cc95fb8a0fb3b7bc2b35d05180ef1870497213b2 Mon Sep 17 00:00:00 2001 From: gennyble Date: Sun, 18 May 2025 14:50:36 -0500 Subject: fix adding udp stats to tcp vec --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac2cafa --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +[![free of syn](https://img.shields.io/badge/free%20of-syn-hotpink)](https://github.com/fasterthanlime/free-of-syn) + +**skim** +skim records the sizes of packets passing through an interface so you +can monitor network usage. it sorts this information by transport type, +tcp/udp, and port number. + +skim exposes an interface for retrieving statistics on tcp port 6666. +first send a u32, big endian, and then json data with the ports you +want. the json should look like this: +`{ "tcp": [80, 443], "udp": [53] }` + +you'll get a response back in a similar format. the first four bytes +will be the length of the response, big endian, and then the json data. +the data'll look like this: +```json +{ + "tcp":[{"port":80,"tx":0,"rx":0},{"port":443,"tx":56260,"rx":4195}], + "udp":[{"port":53,"tx":210,"rx":173}] +} +``` + +skim records network traffic assuming the host system is acting as a server. \ No newline at end of file -- cgit 1.4.1-3-g733a5