package net.pterodactylus.util.fcp;
import java.util.EventListener;
-import java.util.Map;
+import net.pterodactylus.util.fcp.message.CloseConnectionDuplicateClientName;
+import net.pterodactylus.util.fcp.message.NodeHello;
+import net.pterodactylus.util.fcp.message.SSKKeypair;
/**
- * 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 listeners 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 all listeners 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 all listeners 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 listeners 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);
+
}