process::RateLimiterProcess Class Reference

#include <limiter.hpp>

Inheritance diagram for process::RateLimiterProcess:

Public Member Functions
	RateLimiterProcess (int permits, const Duration &duration)
	RateLimiterProcess (double _permitsPerSecond)
void	finalize () override
	Invoked when a process is terminated. More...
Future< Nothing >	acquire ()
Public Member Functions inherited from process::Process< RateLimiterProcess >
	~Process () override
PID< RateLimiterProcess >	self () const
	Returns the PID of the process. More...
Public Member Functions inherited from process::ProcessBase
	ProcessBase (const std::string &id="")
	~ProcessBase () override
const UPID &	self () const
Public Member Functions inherited from process::EventConsumer
virtual	~EventConsumer ()

Additional Inherited Members
Protected Types inherited from process::Process< RateLimiterProcess >
typedef RateLimiterProcess	Self
typedef RateLimiterProcess	This
Protected Types inherited from process::ProcessBase
enum	RemoteConnection { RemoteConnection::REUSE, RemoteConnection::RECONNECT }
	Describes the behavior of the link call when the target pid points to a remote process. More...
typedef lambda::function< void(const UPID &, const std::string &)>	MessageHandler
	Any function which takes a "from" UPID and a message body as arguments. More...
typedef lambda::function< Future< http::Response >const http::Request &)>	HttpRequestHandler
	Any function which takes a process::http::Request and returns a process::http::Response. More...
typedef lambda::function< Future< http::Response > const http::Request &, const Option< http::authentication::Principal > &)>	AuthenticatedHttpRequestHandler
	Any function which takes a process::http::Request and an Option<Principal> and returns a process::http::Response. More...
Protected Member Functions inherited from process::ProcessBase
virtual void	serve (Event &&event)
	Invoked when an event is serviced. More...
void	consume (MessageEvent &&event) override
void	consume (DispatchEvent &&event) override
void	consume (HttpEvent &&event) override
void	consume (ExitedEvent &&event) override
void	consume (TerminateEvent &&event) override
virtual void	initialize ()
	Invoked when a process gets spawned. More...
virtual void	exited (const UPID &)
	Invoked when a linked process has exited. More...
virtual void	lost (const UPID &)
	Invoked when a linked process can no longer be monitored. More...
void	send (const UPID &to, const std::string &name, const char *data=nullptr, size_t length=0)
	Sends the message to the specified UPID. More...
void	send (const UPID &to, std::string &&name)
void	send (const UPID &to, std::string &&name, std::string &&data)
UPID	link (const UPID &pid, const RemoteConnection remote=RemoteConnection::REUSE)
	Links with the specified UPID. More...
void	install (const std::string &name, const MessageHandler &handler)
	Sets up a handler for messages with the specified name. More...
template<typename T >
void	install (const std::string &name, void(T::*method)(const UPID &, const std::string &))
	Sets up a handler for messages with the specified name. More...
void	delegate (const std::string &name, const UPID &pid)
	Delegates incoming messages, with the specified name, to the UPID. More...
void	route (const std::string &name, const Option< std::string > &help, const HttpRequestHandler &handler, const RouteOptions &options=RouteOptions())
	Sets up a handler for HTTP requests with the specified name. More...
template<typename T >
void	route (const std::string &name, const Option< std::string > &help, Future< http::Response >(T::*method)(const http::Request &), const RouteOptions &options=RouteOptions())
	Sets up a handler for HTTP requests with the specified name. More...
void	route (const std::string &name, const std::string &realm, const Option< std::string > &help, const AuthenticatedHttpRequestHandler &handler, const RouteOptions &options=RouteOptions())
template<typename T >
void	route (const std::string &name, const Option< std::string > &realm, const Option< std::string > &help, Future< http::Response >(T::*method)(const http::Request &, const Option< http::authentication::Principal > &), const RouteOptions &options=RouteOptions())
	Forwards to the correct overload of process::ProcessBase::route(), depending on whether the authentication realm realm is present. More...
void	provide (const std::string &name, const std::string &path, const std::map< std::string, std::string > &types=mime::types)
	Sets up the default HTTP request handler to provide the static asset(s) at the specified absolute path for the specified name. More...
template<typename T >
size_t	eventCount ()
	Returns the number of events of the given type currently on the event queue. More...

Constructor & Destructor Documentation

process::RateLimiterProcess::RateLimiterProcess ( int  permits, const Duration &  duration  )

inline

process::RateLimiterProcess::RateLimiterProcess ( double  _permitsPerSecond )

inlineexplicit

Member Function Documentation

Future<Nothing> process::RateLimiterProcess::acquire ( )

inline

void process::RateLimiterProcess::finalize ( )

inlineoverridevirtual

Invoked when a process is terminated.

NOTE: this does not get invoked automatically if process::ProcessBase::consume(TerminateEvent&&) is overridden.

Reimplemented from process::ProcessBase.

---

The documentation for this class was generated from the following file:

• 3rdparty/libprocess/include/process/limiter.hpp