tps

Documentation

Overview

TPS package. TPS is an acronym for Transactions Per Second package. This package allows for TPS control. Users's actual TPS is recalculated on every request and a time penalty is accounted for in case the user's TPS rate is exceeded. Penalties are accumulative, so if a user who is currently voided insists making new requests exceeding her TPS quota, new penalties will add to existing ones. Penalties are stored in-memory in the TPSmap registry. Obsolete penalties are removed from the registry automatically.

Index

• func Init() error
• func IsEnabled() bool
• func Transaction(t string, uid string, tpsMax float32) *time.Time
• type CleanUpCycleRange
• type PenaltyFactorRange
• type PrecisionRange
• type TPS
• type TPSmap

Functions

func Init

func Init() error

Init function initializes TPS control. chcap is the number of request needed to calculate TPS. After a period of a user's inactivity, her TPS control is reset to save server resources. mapcln param sets the time window of inactivity required in order to reset. mapcln starts counting after any TPS related penalty is fulfilled.

func IsEnabled

func IsEnabled() bool

IsEnabled exported. Just by calling Init() once, IsEnabled will return true.

func Transaction

func Transaction(t string, uid string, tpsMax float32) *time.Time

Transaction takes note of the request, recalculates the actual TPS, and returns a datetime if the TPS rate is exceeded. In such case, the user shouldn't be granted access before said datetime. Even if a user is blocked, new request should also be accounted for here, a more distant datetime could be returned.

Types

type CleanUpCycleRange

type CleanUpCycleRange struct {
	msg.Message
}

CleanUpCycleRange exported

type PenaltyFactorRange

type PenaltyFactorRange struct {
	msg.Message
}

PenaltyFactorRange

type PrecisionRange

type PrecisionRange struct {
	msg.Message
}

PrecisionRange exported

type TPS

type TPS struct {
	// contains filtered or unexported fields
}

TPS exported

type TPSmap

type TPSmap map[string]map[string]*TPS

TPSmap exported