lib/queuehandler.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 /**
  23  * Base class for queue handlers.
  24  *
  25  * As of 0.9, queue handlers are short-lived for items as they are
  26  * dequeued by a QueueManager running in an IoMaster in a daemon
  27  * such as queuedaemon.php.
  28  *
  29  * Extensions requiring long-running maintenance or polling should
  30  * register an IoManager.
  31  *
  32  * Subclasses must override at least the following methods:
  33  * - transport
  34  * - handle
  35  */
  36 class QueueHandler
  37 {
  38
  39     /**
  40      * Here's the meat of your queue handler -- you're handed a Notice
  41      * or other object, which you may do as you will with.
  42      *
  43      * If this function indicates failure, a warning will be logged
  44      * and the item is placed back in the queue to be re-run.
  45      *
  46      * @param mixed $object
  47      * @return boolean true on success, false on failure
  48      */
  49     function handle($object)
  50     {
  51         return true;
  52     }
  53 }
  54