src/net/pterodactylus/util/fcp/FcpListener.java

   1 /*
   2  * jSite2 - FpcListener.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.util.fcp;
  21
  22 import java.util.EventListener;
  23
  24 import net.pterodactylus.util.fcp.message.CloseConnectionDuplicateClientName;
  25 import net.pterodactylus.util.fcp.message.NodeHello;
  26
  27 /**
  28  * Interface for objects that want to be notified on certain FCP events.
  29  *
  30  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  31  * @version $Id$
  32  */
  33 public interface FcpListener extends EventListener {
  34
  35         /**
  36          * Notifies listeners that a “NodeHello” message was received.
  37          *
  38          * @param fcpConnection
  39          *            The connection that received the message
  40          * @param nodeHello
  41          *            The “NodeHello” message
  42          */
  43         public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello);
  44
  45         /**
  46          * Notifies all listeners that a “CloseConnectionDuplicateClientName”
  47          * message was received.
  48          *
  49          * @param fcpConnection
  50          *            The connection that received the message
  51          * @param closeConnectionDuplicateClientName
  52          *            The “CloseConnectionDuplicateClientName” message
  53          */
  54         public void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection, CloseConnectionDuplicateClientName closeConnectionDuplicateClientName);
  55
  56         /**
  57          * Notifies listeners that a message has been received. This method is only
  58          * called if {@link FcpConnection#handleMessage(FcpMessage)} does not
  59          * recognize the message. Should that ever happen, please file a bug report!
  60          *
  61          * @param fcpConnection
  62          *            The connection that received the message
  63          * @param fcpMessage
  64          *            The message that was received
  65          */
  66         public void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage);
  67
  68 }