queuehandler.php 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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. if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  20. /**
  21. * Base class for queue handlers.
  22. *
  23. * As of 0.9, queue handlers are short-lived for items as they are
  24. * dequeued by a QueueManager running in an IoMaster in a daemon
  25. * such as queuedaemon.php.
  26. *
  27. * Extensions requiring long-running maintenance or polling should
  28. * register an IoManager.
  29. *
  30. * Subclasses must override at least the following methods:
  31. * - transport
  32. * - handle
  33. */
  34. class QueueHandler
  35. {
  36. /**
  37. * Here's the meat of your queue handler -- you're handed a Notice
  38. * or other object, which you may do as you will with.
  39. *
  40. * If this function indicates failure, a warning will be logged
  41. * and the item is placed back in the queue to be re-run.
  42. *
  43. * @param mixed $object
  44. * @return boolean true on success, false on failure
  45. */
  46. function handle($object)
  47. {
  48. return true;
  49. }
  50. }