queuehandler.php 1.67 KB
Newer Older
1 2
<?php
/*
3
 * StatusNet - the distributed open-source microblogging tool
4
 * Copyright (C) 2008, 2009, StatusNet, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

20
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
21

22 23 24
/**
 * Base class for queue handlers.
 *
25 26 27 28 29 30
 * As of 0.9, queue handlers are short-lived for items as they are
 * dequeued by a QueueManager running in an IoMaster in a daemon
 * such as queuedaemon.php.
 *
 * Extensions requiring long-running maintenance or polling should
 * register an IoManager.
31 32 33
 *
 * Subclasses must override at least the following methods:
 * - 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 44 45
     *
     * If this function indicates failure, a warning will be logged
     * and the item is placed back in the queue to be re-run.
     *
46
     * @param mixed $object
47 48
     * @return boolean true on success, false on failure
     */
49
    function handle($object)
50
    {
51 52
        return true;
    }
53
}
54