Document hook_hosting_queues [#1113560]

Coming from #1111254: Document the Hostmaster API I'd like to document hook_hosting_queues, which boils down to documenting the following array from hosting_get_queues:


    $defaults = array(
      'type' => 'serial', 
      'max_threads' => 6, 
      'threshold' => '100', 
      'min_threads' => 1, 
      'timeout' => strtotime("10 minutes", 0), 
      'frequency' => strtotime("5 minutes", 0), 
      'items' => 5, 
      'enabled' => TRUE, 
      'singular' => t('item'), 
      'plural' => t('items'),
    );

What are the threads about, and what is the 'threshold' about eh?

Comments

Comment #1

omega8cc commented 1 April 2011 at 20:31

It is used a few lines later in the modules/hosting/hosting.queues.inc

      if ($queue['type'] == 'batch') {
        $threads = $queue['total_items'] / $queue['threshold'];
        if ($threads <= $queue['min_threads']) {
          $threads = $queue['min_threads'];
        } elseif ($thread > $queue['max_threads']) {
          $threads = $queue['max_threads'];
        }
        $queue['calc_threads'] = $threads;
        $queue['calc_frequency'] = ceil($queue['frequency'] / $threads);
        $queue['calc_items'] = ceil($queue['total_items'] / $threads);
      }

Comment #2

omega8cc commented 1 April 2011 at 20:34

But yeah, reading "the code as documentation" is always easier than "translating code to documentation" :)

Comment #3

steven jones commented 1 April 2011 at 20:36

Indeed, I think my original questions stand ;)

Comment #4

anarcat commented 13 April 2011 at 23:59

Category:

bug

» task

I think the idea of the threshold is that it's a heuristic to determine how many threads we need to fire up to process the tasks in that batch, to avoid going over memory limits and things like that.

For example, hosting_cron allows between 6 and 12 cron jobs to run at a time on one server... Presumably this could be tuned...