NAME

Gungho::Component::Throttle::Domain - Throttle By Domain

SYNOPSIS

  ---
  throttle:
    domain:
      max_items 1000
      interval: 3600
      domains:
        - match: 'A [Regular]+ Exp?ression'
        - match: \.cpan\.org$
  components:
    - Throttle::Domain

DESCRIPITION

This component allows you to throttle requests by domain names.

You can specify a regular expression, in which case only the domains that match the particular regular expression will be throttled. Otherwise, the hostname from each request will be used as the key to throttle.

CONFIGURATION

All configuration parameters are specified in throttle.domain hash:

  throttle:
    doamin:
      key1: value

max_items

Specifies the max number of items that can be fetched within the time specified in "interval"

interval

Specifies the interval to which to apply the max_items configuration.

domains

Specifies the domain to apply the throttling. If unspecified, the same throttling configuration will be applied to all domains

METHODS

setup

throttle($request)

Checks if a request can be executed succesfully. Returns 1 if it's ok to execute the request.