Struct RateLimitedRouter 

pub struct RateLimitedRouter<TRouter, TRateLimit> {
    pub router: TRouter,
    pub rate_limiter: TRateLimit,
}

A generic struct which wraps the message router and adds support for a rate-limiting implementation to rate limit jobs processed by the factory. This handles the plubming around wrapping a rate limited message router

Fields

router: TRouter

The underlying message router which does NOT implement rate limiting

rate_limiter: TRateLimit

The rate limiter to apply to the message routing

Implementations

impl<TRouter, TRateLimit> RateLimitedRouter<TRouter, TRateLimit>

pub fn builder() -> RateLimitedRouterBuilder<TRouter, TRateLimit>

Create an instance of RateLimitedRouter using the builder syntax

Trait Implementations

impl<TRouter, TRateLimit> Debug for RateLimitedRouter<TRouter, TRateLimit>

where TRouter: Debug, TRateLimit: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<TKey, TMsg, TRouter, TRateLimit> Router<TKey, TMsg> for RateLimitedRouter<TRouter, TRateLimit>

where TKey: JobKey, TMsg: Message, TRouter: Router<TKey, TMsg>, TRateLimit: RateLimiter,

fn route_message( &mut self, job: Job<TKey, TMsg>, pool_size: usize, worker_hint: Option<usize>, worker_pool: &mut HashMap<usize, WorkerProperties<TKey, TMsg>>, ) -> Result<RouteResult<TKey, TMsg>, Box<dyn Error + Sync + Send>>

Route a Job based on the specific routing methodology

fn choose_target_worker( &mut self, job: &Job<TKey, TMsg>, pool_size: usize, worker_hint: Option<usize>, worker_pool: &HashMap<usize, WorkerProperties<TKey, TMsg>>, ) -> Option<usize>

Identifies if a job CAN be routed, and to which worker, without requiring dequeueing the job

fn is_factory_queueing(&self) -> bool

Returns a flag indicating if the factory does discard/overload management (true) or if is handled by the workers worker(s) (false)