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