src/main/kotlin/net/pterodactylus/sone/freenet/plugin/PluginConnector.kt

   1 /*
   2  * Sone - PluginConnector.kt - Copyright © 2010–2020 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.freenet.plugin
  19
  20 import freenet.support.*
  21 import freenet.support.api.*
  22
  23 /**
  24  * Interface for talking to other plugins. Other plugins are identified by their
  25  * name and a unique connection identifier.
  26  */
  27 interface PluginConnector {
  28
  29         /**
  30          * Sends a message to another plugin running in the same node.
  31          *
  32          * @param pluginName The fully qualified name of the plugin
  33          * @param fields The message being sent
  34          * @param data Optional data
  35          * @return The reply from the plugin
  36          * @throws PluginException if the plugin identified by [pluginName] does not exist
  37          */
  38         @Throws(PluginException::class)
  39         suspend fun sendRequest(pluginName: String, fields: SimpleFieldSet, data: Bucket? = null): PluginReply
  40
  41 }
  42
  43 data class PluginReply(val fields: SimpleFieldSet, val data: Bucket?)