NET_RateLimit.h File Reference

#include "NET_API.h"
#include "NET_UrlHandlerDecorator.h"
#include <UT/UT_StringHolder.h>
#include <UT/UT_Function.h>
#include <UT/UT_StringArray.h>

Include dependency graph for NET_RateLimit.h:

Go to the source code of this file.

Classes
class	NET_HTTPRate
class	NET_HTTPRateLimit
class	NET_RateLimitDecorator

Enumerations
enum	NET_HTTPRateKey { NET_HTTPRateKey::RATE_IP, NET_HTTPRateKey::RATE_IP_OR_USER }

Functions
NET_API bool	NETisRateLimited (const NET_HTTPRequest &request, const UT_StringRef &group, NET_HTTPRateKey key, const NET_HTTPRate &rate, const UT_StringArray &methods=UT_StringArray(), bool increment=false)
NET_API NET_HTTPRateLimit	NETgetRateUsage (const NET_HTTPRequest &request, const UT_StringRef &group, NET_HTTPRateKey key, const NET_HTTPRate &rate, const UT_StringArray &methods, bool increment)

Enumeration Type Documentation

enum NET_HTTPRateKey

strong

Enumerator
RATE_IP
RATE_IP_OR_USER

Definition at line 26 of file NET_RateLimit.h.

Function Documentation

NET_API NET_HTTPRateLimit NETgetRateUsage	(	const NET_HTTPRequest &	request,
		const UT_StringRef &	group,
		NET_HTTPRateKey	key,
		const NET_HTTPRate &	rate,
		const UT_StringArray &	methods,
		bool	increment
	)

NET_API bool NETisRateLimited	(	const NET_HTTPRequest &	request,
		const UT_StringRef &	group,
		NET_HTTPRateKey	key,
		const NET_HTTPRate &	rate,
		const UT_StringArray &	methods = UT_StringArray(),
		bool	increment = false
	)