README

This API is designed to build up the IPQS plugin for Traefik and Caddy by @z3ntl3

There are rules for it to be used effectively, with no additional costs, performance-vise.

Rules

• Always allocate no more than one ipqs.Client using ipqs.New
• Reuse the same client using a reference, which should be allocated no more than once

Performance | important

When using this package, the caller must either use the API with own caching implementation, or prefer to use the default in-memory cache, which is enabled by default.

To disable: ipqs.EnableCaching = false

When using the built-in cache

• Set the TTL once by having a context.WithValue as a parent to your context, be sure to use ipqs.TTL_key to set the key

Bench (with in memory cache enabled-by default)

Running tool: C:\Program Files\Go\bin\go.exe test -benchmem -run=^$ -bench ^BenchmarkClient$ github.com/SimpaiX-net/ipqs/tests

goos: windows
goarch: amd64
pkg: github.com/SimpaiX-net/ipqs/tests
cpu: AMD Ryzen 7 4800H with Radeon Graphics         
BenchmarkClient-16    	 8923340	       135.7 ns/op	     256 B/op	       4 allocs/op
PASS
ok  	github.com/SimpaiX-net/ipqs/tests	2.911s