add ModifyPeer command

[jSite2.git] / src / net / pterodactylus / util / fcp / FcpListener.java

diff --git a/src/net/pterodactylus/util/fcp/FcpListener.java b/src/net/pterodactylus/util/fcp/FcpListener.java
index e3d6d00..aa8147b 100644 (file)
--- a/src/net/pterodactylus/util/fcp/FcpListener.java
+++ b/src/net/pterodactylus/util/fcp/FcpListener.java
@@ -20,25 +20,97 @@
 package net.pterodactylus.util.fcp;
 
 import java.util.EventListener;
-import java.util.Map;
 
 
 /**
- * TODO
+ * Interface for objects that want to be notified on certain FCP events.
+ * 
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  * @version $Id$
  */
 public interface FcpListener extends EventListener {
 
-       public void fcpConnected(FcpConnection fcpConnection);
-       public void fcpDisconnected(FcpConnection fcpConnection);
-       
-       //
-       // connection setup
-       //
-       
-       public void fcpNodeHello(FcpConnection fcpConnection, Map<String, String> nodeProperties);
-       public void fcpCloseConnectionDuplicateName(FcpConnection fcpConnection);
-       
-       
+       /**
+        * Notifies a listener that a “NodeHello” message was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
+        * @param nodeHello
+        *            The “NodeHello” message
+        */
+       public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello);
+
+       /**
+        * Notifies a listener that a “CloseConnectionDuplicateClientName” message
+        * was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
+        * @param closeConnectionDuplicateClientName
+        *            The “CloseConnectionDuplicateClientName” message
+        */
+       public void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection, CloseConnectionDuplicateClientName closeConnectionDuplicateClientName);
+
+       /**
+        * Notifies a listener that a “SSKKeypair” message was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received themessage
+        * @param sskKeypair
+        *            The “SSKKeypair” message
+        */
+       public void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair);
+
+       /**
+        * Notifies a listener that a “Peer” message was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
+        * @param peer
+        *            The “Peer” message
+        */
+       public void receivedPeer(FcpConnection fcpConnection, Peer peer);
+
+       /**
+        * Notifies a listener that an “EndListPeers” message was received.
+        * 
+        * @param fcpConnection
+        *            The connection that recevied the message
+        * @param endListPeers
+        *            The “EndListPeers” message
+        */
+       public void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers);
+
+       /**
+        * Notifies a listener that a “PeerNote” message was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
+        * @param peerNote
+        *            The “PeerNote” message
+        */
+       public void receviedPeerNote(FcpConnection fcpConnection, PeerNote peerNote);
+
+       /**
+        * Notifies a listener that an “EndListPeerNotes” message was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
+        * @param endListPeerNotes
+        *            The “EndListPeerNotes” message
+        */
+       public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes);
+
+       /**
+        * Notifies a listener that a message has been received. This method is only
+        * called if {@link FcpConnection#handleMessage(FcpMessage)} does not
+        * recognize the message. Should that ever happen, please file a bug report!
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
+        * @param fcpMessage
+        *            The message that was received
+        */
+       public void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage);
+
 }