PHP Interface Stiphle\Throttle\ThrottleInterface

Author: Dave Marshall ([email protected])
Show file Open project: davedevelopment/stiphle

Public Methods

Method Description
getEstimate ( string $key, integer $limit, integer $milliseconds ) : integer Get Estimate
throttle ( string $key, integer $limit, integer $milliseconds ) : void Throttle

Method Details

getEstimate() public method

If I were to throttle now, how long would I be waiting
public getEstimate ( string $key, integer $limit, integer $milliseconds ) : integer
$key string - A unique key for what we're throttling
$limit integer - How many are allowed
$milliseconds integer - In this many milliseconds
return integer - the number of milliseconds before this request should be allowed

throttle() public method

Throttle
public throttle ( string $key, integer $limit, integer $milliseconds ) : void
$key string - A unique key for what we're throttling
$limit integer - How many are allowed
$milliseconds integer - In this many milliseconds
return void