interface GeocoderThrottleInterface in Geocoder 8.3

Provides a geocoder throttle interface.

Hierarchy

• interface \Drupal\geocoder\GeocoderThrottleInterface

File

src/GeocoderThrottleInterface.php, line 8

Namespace

Drupal\geocoder

interface GeocoderThrottleInterface {

  /**
   * Sleeps until the throttle rate is not reached anymore.
   *
   * @param string $key
   *   An identifier for the service where we send the requests.
   * @param array|null $throttle_info
   *   An associative array with:
   *   - period: in seconds
   *   - limit: number of requests allowed in the period
   *   or null not to limit the requests.
   *
   * @return void|NULL
   */
  public function waitForAvailability(string $key, array $throttle_info);

}

Members

Name	Modifiers	Type	Description	Overrides
GeocoderThrottleInterface::waitForAvailability	public	function	Sleeps until the throttle rate is not reached anymore.	1