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