Skip to content

Commit

Permalink
docs: Added bandwidth tracking to features list
Browse files Browse the repository at this point in the history
  • Loading branch information
TwoTenPvP committed Jul 22, 2020
1 parent ea821b7 commit bc64ec4
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Ruffles has many features that other libs lack. See below for a summary and a de
* Ack merging
* Connection statistics
* Path MTU discovery
* Bandwidth tracking

### Connection Challenge
The Ruffles protocol requires a challenge to be completed before a connection can be established. Currently, the challenge is a hashcash like challenge that is supplied by the server, brute force solved by the client and submitted. (Uses Fowler-Noll-Vo hash function instead of SHA1 currently).
Expand Down Expand Up @@ -97,6 +98,9 @@ Detailed statistics can be retrieved from connections, including the bytes sent,
### Path MTU
Automatically discovers the largest MTU possible for each connection.

### Bandwidth Tracking
Limit the amount of traffic allowed to be sent to a connection. Custom algorithms can be adapted with the IBandwidthTracker interface.

## Roadmap
This is stuff I want to and plan to add

Expand Down

0 comments on commit bc64ec4

Please sign in to comment.