2 * Sone - PluginConnector.kt - Copyright © 2010–2019 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.freenet.plugin
20 import com.google.common.eventbus.*
21 import com.google.inject.*
22 import freenet.pluginmanager.*
23 import freenet.support.*
24 import freenet.support.api.*
25 import net.pterodactylus.sone.freenet.plugin.event.*
28 * Interface for talking to other plugins. Other plugins are identified by their
29 * name and a unique connection identifier.
31 interface PluginConnector {
34 * Sends a message to another plugin running in the same node.
36 * @param pluginName The fully qualified name of the plugin
37 * @param identifier The unique identifier of the request
38 * @param fields The message being sent
39 * @param data Optional data
41 @Throws(PluginException::class)
42 fun sendRequest(pluginName: String, identifier: String, fields: SimpleFieldSet, data: Bucket? = null): Unit
47 * Fred-based [PluginConnector] implementation.
49 class FredPluginConnector @Inject constructor(
50 private val eventBus: EventBus,
51 private val pluginRespiratorFacade: PluginRespiratorFacade
52 ) : PluginConnector, FredPluginTalker {
54 override fun sendRequest(pluginName: String, identifier: String, fields: SimpleFieldSet, data: Bucket?) =
55 getPluginTalker(pluginName, identifier).send(fields, data)
57 private fun getPluginTalker(pluginName: String, identifier: String) =
59 pluginRespiratorFacade.getPluginTalker(this, pluginName, identifier)
60 } catch (pnfe1: PluginNotFoundException) {
61 throw PluginException(pnfe1)
64 override fun onReply(pluginName: String, identifier: String, params: SimpleFieldSet, data: Bucket) =
65 eventBus.post(ReceivedReplyEvent(this, pluginName, identifier, params, data))