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.EndListPeers;
  26 import net.pterodactylus.util.fcp.message.NodeHello;
  27 import net.pterodactylus.util.fcp.message.Peer;
  28 import net.pterodactylus.util.fcp.message.SSKKeypair;
  29
  30 /**
  31  * Interface for objects that want to be notified on certain FCP events.
  32  *
  33  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  34  * @version $Id$
  35  */
  36 public interface FcpListener extends EventListener {
  37
  38         /**
  39          * Notifies a listener that a “NodeHello” message was received.
  40          *
  41          * @param fcpConnection
  42          *            The connection that received the message
  43          * @param nodeHello
  44          *            The “NodeHello” message
  45          */
  46         public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello);
  47
  48         /**
  49          * Notifies a listener that a “CloseConnectionDuplicateClientName” message
  50          * was received.
  51          *
  52          * @param fcpConnection
  53          *            The connection that received the message
  54          * @param closeConnectionDuplicateClientName
  55          *            The “CloseConnectionDuplicateClientName” message
  56          */
  57         public void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection, CloseConnectionDuplicateClientName closeConnectionDuplicateClientName);
  58
  59         /**
  60          * Notifies a listener that a “SSKKeypair” message was received.
  61          *
  62          * @param fcpConnection
  63          *            The connection that received themessage
  64          * @param sskKeypair
  65          *            The “SSKKeypair” message
  66          */
  67         public void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair);
  68
  69         /**
  70          * Notifies a listener that a “Peer” message was received.
  71          *
  72          * @param fcpConnection
  73          *            The connection that received the message
  74          * @param peer
  75          *            The “Peer” message
  76          */
  77         public void receivedPeer(FcpConnection fcpConnection, Peer peer);
  78
  79         /**
  80          * Notifies a listener that an “EndListPeers” message was received.
  81          *
  82          * @param fcpConnection
  83          *            The connection that recevied the message
  84          * @param endListPeers
  85          *            The “EndListPeers” message
  86          */
  87         public void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers);
  88
  89         /**
  90          * Notifies a listener that a message has been received. This method is only
  91          * called if {@link FcpConnection#handleMessage(FcpMessage)} does not
  92          * recognize the message. Should that ever happen, please file a bug report!
  93          *
  94          * @param fcpConnection
  95          *            The connection that received the message
  96          * @param fcpMessage
  97          *            The message that was received
  98          */
  99         public void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage);
 100
 101 }