]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/immanager.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / lib / immanager.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  * IKM background connection manager for IM-using queue handlers,
24  * allowing them to send outgoing messages on the right connection.
25  *
26  * In a multi-site queuedaemon.php run, one connection will be instantiated
27  * for each site being handled by the current process that has IM enabled.
28  *
29  * Implementations that extend this class will likely want to:
30  * 1) override start() with their connection process.
31  * 2) override handleInput() with what to do when data is waiting on
32  *    one of the sockets
33  * 3) override idle($timeout) to do keepalives (if necessary)
34  * 4) implement send_raw_message() to send raw data that ImPlugin::enqueueOutgoingRaw
35  *      enqueued
36  */
37
38 abstract class ImManager extends IoManager
39 {
40     abstract function send_raw_message($data);
41
42     function __construct($imPlugin)
43     {
44         $this->plugin = $imPlugin;
45         $this->plugin->imManager = $this;
46     }
47
48     /**
49      * Fetch the singleton manager for the current site.
50      * @return mixed ImManager, or false if unneeded
51      */
52     public static function get()
53     {
54         throw new Exception('ImManager should be created using it\'s constructor, not the static get method');
55     }
56 }