shaper

Documentation

Index

• type Config
• type Shaper
  • func New(cfg Config) (Shaper, error)
  • func (s *Shaper) RateLimiter() *rate.Limiter
• type Shapers
  • func (ss Shapers) DefaultC2S() *Shaper
  • func (ss Shapers) DefaultS2S() *Shaper
  • func (ss Shapers) MatchingJID(j *jid.JID) *Shaper

Types

type Config

type Config struct {
	Name        string `fig:"name"`
	MaxSessions int    `fig:"max_sessions" default:"10"`
	Rate        struct {
		Limit int `fig:"limit" default:"1000"`
		Burst int `fig:"burst" default:"0"`
	} `fig:"rate"`
	Matching struct {
		JID struct {
			In    []string `fig:"in"`
			RegEx string   `fig:"regex"`
		}
	} `fig:"matching"`
}

Config contains Shaper configuration parameters.

type Shaper

type Shaper struct {
	// Name is the shaper name.
	Name string

	// MaxSessions represents maximum sessions count.
	MaxSessions int
	// contains filtered or unexported fields
}

Shaper represents a connection traffic constraint set.

func New

func New(cfg Config) (Shaper, error)

New returns a new Shaper given a configuration.

func (*Shaper) RateLimiter

func (s *Shaper) RateLimiter() *rate.Limiter

RateLimiter returns a new rate limiter configured with shaper parameters.

type Shapers

type Shapers []Shaper

Shapers represents a shaper collection ordered by priority.

func (Shapers) DefaultC2S

func (ss Shapers) DefaultC2S() *Shaper

DefaultC2S returns C2S default shaper.

func (Shapers) DefaultS2S

func (ss Shapers) DefaultS2S() *Shaper

DefaultS2S returns S2S default shaper.

func (Shapers) MatchingJID

func (ss Shapers) MatchingJID(j *jid.JID) *Shaper

MatchingJID returns the shaper that should be applied to a given JID.