1
2
mirror of https://github.com/yunginnanet/Rate5 synced 2024-06-28 18:11:01 +00:00
Go to file
2021-09-29 05:23:26 -07:00
_examples Fix: Major bug with Peek. New: test cases 2021-09-28 01:24:04 -07:00
.github/workflows Create go.yml 2021-09-29 02:57:02 -07:00
go.mod initial commit 2021-08-27 23:22:25 -07:00
go.sum initial commit 2021-08-27 23:22:25 -07:00
LICENSE Add new functions, rename things, add documentation 2021-08-28 07:39:22 -07:00
models.go bugfix 2021-09-29 01:25:44 -07:00
ratelimiter_test.go Testing: concurrency safety 2021-09-29 05:18:51 -07:00
ratelimiter.go Testing: concurrency safety 2021-09-29 05:18:51 -07:00
README.md Update README 2021-09-29 05:23:26 -07:00

Rate5

GoDoc Go Report Card Go

A generic ratelimitter for any golang project.
See the docs and the examples below for more details.

Short Example

import rate5 "github.com/yunginnanet/rate5"    

var Rater *rate5.Limiter   

[...]  
type Client struct {
        ID   string
        Conn net.Conn

        loggedin  bool
}  

// Rate5 doesn't care where you derive the string used for ratelimiting
func (c Client) UniqueKey() string {
        if !c.loggedin {
                host, _, _ := net.SplitHostPort(c.Conn.RemoteAddr().String())
                return host
        }
        return c.ID
}
  
func (s *Server) handleTCP(c *Client) {
	// Returns true if ratelimited
	if Rater.Check(c) {
		c.Conn.Write([]byte("too many connections"))  
		c.Conn.Close()
		return
	}
[...]
    

In-depth example

Concurrent TCP Server with Rate5 Ratelimiter

To-Do

More Documentation
More To-Dos
Test Cases More test cases.