Interface to specify the algorithm the Ratelimiter should use. More...

#include <ratelimiter.hpp>

Public Types
using	permit_type = Permit
	The type of the permit returned by acquire.

using	error_type = Error
	The type of the error returned by acquire.

Public Member Functions
virtual Variant< permit_type, error_type >	acquire ()=0
	Acquire a single permit to execute a request. More...

virtual void	release (permit_type)=0
	Release a permit that was previously acquired. More...

Detailed Description

Interface to specify the algorithm the Ratelimiter should use.

Template Parameters

Permit	The type of permits the strategy returns.
Error	The kind of error returned when acquire fails.

Member Function Documentation

template<typename Permit, typename Error>

virtual Variant<permit_type, error_type> resilient::IRateLimiterStrategy< Permit, Error >::acquire ( )

pure virtual

Acquire a single permit to execute a request.

acquire() is called before invoking the function to wait for a permit. This call may block.

Returns: Either return a permit or an error. If a permit is returned release() is called with the permit.

template<typename Permit, typename Error>

virtual void resilient::IRateLimiterStrategy< Permit, Error >::release ( permit_type )

pure virtual

Release a permit that was previously acquired.

release() is called after the invoked function returned or throwed.

Parameters

permit_type The permit returned by acquire().

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