U Dx`-=@sddlZddlZGdddeZGdddeZGdddeZGdd d eZGd d d eZGd d d eZ GdddeZ GdddeZ dS)NcseZdZfddZZS)RequestExceededExceptioncs,||_||_d||f}tt||dS)aError when requested amount exceeds what is allowed The request that raised this error should be retried after waiting the time specified by ``retry_time``. :type requested_amt: int :param requested_amt: The originally requested byte amount :type retry_time: float :param retry_time: The length in time to wait to retry for the requested amount zeZdZdddZddZddZdd Zd d Zd d ZdS) LeakyBucketNcCsZt||_||_|dkr t|_t|_||_|dkr@t|_||_ |dkrVt |_ dS)a9A leaky bucket abstraction to limit bandwidth consumption :type rate: int :type rate: The maximum rate to allow. This rate is in terms of bytes per second. :type time_utils: TimeUtils :param time_utils: The time utility to use for interacting with time :type rate_tracker: BandwidthRateTracker :param rate_tracker: Tracks bandwidth consumption :type consumption_scheduler: ConsumptionScheduler :param consumption_scheduler: Schedules consumption retries when necessary N) float _max_raterr threadingLock_lock _rate_trackerBandwidthRateTracker_consumption_schedulerConsumptionScheduler)rZmax_raterZ rate_trackerZconsumption_schedulerr r r rs  zLeakyBucket.__init__c Csz|jj|j}|j|r8||||W5QRS|||rT||||n|||W5QRSW5QRXdS)acConsume an a requested amount :type amt: int :param amt: The amount of bytes to request to consume :type request_token: RequestToken :param request_token: The token associated to the consumption request that is used to identify the request. So if a RequestExceededException is raised the token should be used in subsequent retry consume() request. :raises RequestExceededException: If the consumption amount would exceed the maximum allocated bandwidth :rtype: int :returns: The amount consumed N) rCrrrF is_scheduled,_release_requested_amt_for_scheduled_request_projected_to_exceed_max_rate!_raise_request_exceeded_exception_release_requested_amtramt request_tokentime_nowr r r r0s   zLeakyBucket.consumecCs|j||}||jkSr4)rDget_projected_rater@)rrNrPZprojected_rater r r rJ sz)LeakyBucket._projected_to_exceed_max_ratecCs|j||||Sr4)rFprocess_scheduled_consumptionrLrMr r r rIsz8LeakyBucket._release_requested_amt_for_scheduled_requestcCs.|t|j}|j|||}t||ddS)N)rr)r?r@rFschedule_consumptionr)rrNrOrPZallocated_timerr r r rKsz-LeakyBucket._raise_request_exceeded_exceptioncCs|j|||Sr4)rDrecord_consumption_rate)rrNrPr r r rLsz"LeakyBucket._release_requested_amt)NNN) r rrrr0rJrIrKrLr r r r r>s r>c@s,eZdZddZddZddZddZd S) rGcCsi|_d|_dS)z*Schedules when to consume a desired amountrN) _tokens_to_scheduled_consumption _total_waitrr r r r!szConsumptionScheduler.__init__cCs ||jkS)zIndicates if a consumption request has been scheduled :type token: RequestToken :param token: The token associated to the consumption request that is used to identify the request. )rU)rtokenr r r rH&sz!ConsumptionScheduler.is_scheduledcCs&|j|7_|j|d|j|<|jS)aSchedules a wait time to be able to consume an amount :type amt: int :param amt: The amount of bytes scheduled to be consumed :type token: RequestToken :param token: The token associated to the consumption request that is used to identify the request. :type time_to_consume: float :param time_to_consume: The desired time it should take for that specific request amount to be consumed in regardless of previously scheduled consumption requests :rtype: float :returns: The amount of time to wait for the specific request before actually consuming the specified amount. )Z wait_durationtime_to_consume)rVrU)rrNrWrXr r r rS/s  z)ConsumptionScheduler.schedule_consumptioncCs&|j|}t|j|dd|_dS)zProcesses a scheduled consumption request that has completed :type token: RequestToken :param token: The token associated to the consumption request that is used to identify the request. rXrN)rUpopmaxrV)rrWZscheduled_retryr r r rRIs   z2ConsumptionScheduler.process_scheduled_consumptionN)r rrrrHrSrRr r r r rG s rGc@sBeZdZdddZeddZddZdd Zd d Zd d Z dS)rE皙?cCs||_d|_d|_dS)aTracks the rate of bandwidth consumption :type a: float :param a: The constant to use in calculating the exponentional moving average of the bandwidth rate. Specifically it is used in the following calculation: current_rate = alpha * new_rate + (1 - alpha) * current_rate This value of this constant should be between 0 and 1. N)_alpha _last_time _current_rate)ralphar r r rVs zBandwidthRateTracker.__init__cCs|jdkrdS|jS)zmThe current transfer rate :rtype: float :returns: The current tracked transfer rate N)r]r^rr r r current_ratefs z!BandwidthRateTracker.current_ratecCs|jdkrdS|||S)aZGet the projected rate using a provided amount and time :type amt: int :param amt: The proposed amount to consume :type time_at_consumption: float :param time_at_consumption: The proposed time to consume at :rtype: float :returns: The consumption rate if that amt and time were consumed Nr`)r]*_calculate_exponential_moving_average_raterrNtime_at_consumptionr r r rQqs z'BandwidthRateTracker.get_projected_ratecCs2|jdkr||_d|_dS||||_||_dS)aRecord the consumption rate based off amount and time point :type amt: int :param amt: The amount that got consumed :type time_at_consumption: float :param time_at_consumption: The time at which the amount was consumed Nr`)r]r^rbrcr r r rTs z,BandwidthRateTracker.record_consumption_ratecCs"||j}|dkrtdS||S)Nrinf)r]r?)rrNrdZ time_deltar r r _calculate_rates z$BandwidthRateTracker._calculate_ratecCs&|||}|j|d|j|jS)N)rfr\r^)rrNrdZnew_rater r r rbs z?BandwidthRateTracker._calculate_exponential_moving_average_rateN)r[) r rrrpropertyrarQrTrfrbr r r r rEUs   rE) rrA Exceptionrobjectrrrrr>rGrEr r r r  s%jR5