From d539959a2ab33f7b7564f412c2b14b77d66d43c6 Mon Sep 17 00:00:00 2001
From: Jose Celano <josecelano@gmail.com>
Date: Tue, 10 Dec 2024 11:01:09 +0000
Subject: [PATCH] docs: [#1096] add mod doc the banning mod

---
 src/servers/udp/server/banning.rs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/servers/udp/server/banning.rs b/src/servers/udp/server/banning.rs
index 33db5d2a..8891db86 100644
--- a/src/servers/udp/server/banning.rs
+++ b/src/servers/udp/server/banning.rs
@@ -1,3 +1,13 @@
+//! Banning service for UDP tracker.
+//! 
+//! It bans clients that send invalid connection id's.
+//! 
+//! It uses a Counting Bloom Filter to keep track of the number of connection id 
+//! errors per ip. That means there can be false positives, but not false 
+//! negatives.
+//! 
+//! 1 out of 100000 requests will be a false positive and the client will not
+//! receive a response.
 use std::net::IpAddr;
 
 use bloom::{CountingBloomFilter, ASMS};