function throttle_help in Drupal 6

Same name and namespace in other branches

1. 4 modules/throttle.module \throttle_help()
2. 5 modules/throttle/throttle.module \throttle_help()

Implementation of hook_help().

File

modules/throttle/throttle.module, line 117

Allows configuration of congestion control auto-throttle mechanism.

Code

function throttle_help($path, $arg) {
  switch ($path) {
    case 'admin/help#throttle':
      $output = '<p>' . t('The throttle module provides a congestion control mechanism that automatically adjusts to a surge in incoming traffic. If your site is referenced by a popular website, or experiences a "Denial of Service" (DoS) attack, your webserver might become overwhelmed. The throttle mechanism is utilized by modules to temporarily disable CPU-intensive functionality, increasing performance. For instance, via the throttle module, modules may choose to disable resource-intensive blocks or the code within the site theme may temporarily disable user pictures in posts.') . '</p>';
      $output .= '<p>' . t('The congestion control throttle can be automatically enabled when the number of anonymous or authenticated users currently visiting the site exceeds a specified threshold.') . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@throttle">Throttle module</a>.', array(
        '@throttle' => 'http://drupal.org/handbook/modules/throttle/',
      )) . '</p>';
      return $output;
    case 'admin/settings/throttle':
      return '<p>' . t('The throttle module provides a congestion control mechanism that automatically adjusts to a surge in incoming traffic. If your site is referenced by a popular website, or experiences a "Denial of Service" (DoS) attack, your webserver might become overwhelmed. The throttle mechanism is utilized by modules to temporarily disable CPU-intensive functionality, increasing performance.') . '</p>';
  }
}