src/main/java/net/pterodactylus/sone/freenet/plugin/ConnectorListener.java

   1 /*
   2  * Sone - ConnectorListener.java - Copyright © 2010–2012 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 java.util.EventListener;
  21
  22 import freenet.support.SimpleFieldSet;
  23 import freenet.support.api.Bucket;
  24
  25 /**
  26  * Interface for objects that want to be notified if a {@link PluginConnector}
  27  * receives a reply from a plugin. As a connection listener is always
  28  * {@link PluginConnector#addConnectorListener(String, String, ConnectorListener)
  29  * added} for a specific plugin, it will always be notified for replies from the
  30  * correct plugin (unless you register the same listener for multiple
  31  * plugins—which you subsequently should not do).
  32  *
  33  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  34  */
  35 public interface ConnectorListener extends EventListener {
  36
  37         /**
  38          * A reply was received from the plugin this connection listener was added
  39          * for.
  40          *
  41          * @param pluginConnector
  42          *            The plugin connector that received the reply
  43          * @param fields
  44          *            The fields of the reply
  45          * @param data
  46          *            The data of the reply (may be null)
  47          */
  48         public void receivedReply(PluginConnector pluginConnector, SimpleFieldSet fields, Bucket data);
  49
  50 }