Files
x/limiter/conn/generator.go
T
ginuerzh fa708f4b5f docs(limiter/conn): add doc comments, fix nil guards and missing Close
Add package and exported symbol doc comments across conn, generator,
limiter, and wrapper packages. Fix nil receiver guard in
connLimitSingleGenerator.Limiter, add missing httpLoader.Close call,
return context.Background instead of nil in serverConn.Context, return
explicit error on connection limit exceeded, and simplify Allow logic.
2026-05-24 19:38:07 +08:00

52 lines
1.1 KiB
Go

package conn
import (
limiter "github.com/go-gost/core/limiter/conn"
)
// ConnLimitGenerator creates individual Limiter instances for use in
// per-IP or per-CIDR connection limiting.
type ConnLimitGenerator interface {
Limiter() limiter.Limiter
}
type connLimitGenerator struct {
n int
}
// NewConnLimitGenerator returns a ConnLimitGenerator that creates a new
// Limiter on each call to Limiter(), using the given limit n.
func NewConnLimitGenerator(n int) ConnLimitGenerator {
return &connLimitGenerator{
n: n,
}
}
func (p *connLimitGenerator) Limiter() limiter.Limiter {
if p == nil || p.n <= 0 {
return nil
}
return NewLimiter(p.n)
}
type connLimitSingleGenerator struct {
limiter limiter.Limiter
}
// NewConnLimitSingleGenerator returns a ConnLimitGenerator that always
// returns the same Limiter instance, using the given limit n.
func NewConnLimitSingleGenerator(n int) ConnLimitGenerator {
p := &connLimitSingleGenerator{}
if n > 0 {
p.limiter = NewLimiter(n)
}
return p
}
func (p *connLimitSingleGenerator) Limiter() limiter.Limiter {
if p == nil {
return nil
}
return p.limiter
}