Allow detaching the client from its connection.
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / highlevel / FcpClient.java
index 3012e00..78cb198 100644 (file)
@@ -83,46 +83,43 @@ public class FcpClient {
        /** Listener management. */
        private final FcpClientListenerManager fcpClientListenerManager = new FcpClientListenerManager(this);
 
-       /** The name of this client. */
-       private final String name;
-
        /** The underlying FCP connection. */
        private final FcpConnection fcpConnection;
 
+       /** The {@link NodeHello} data sent by the node on connection. */
+       private volatile NodeHello nodeHello;
+
        /** Whether the client is currently connected. */
        private volatile boolean connected;
 
+       /** The listener for “connection closed” events. */
+       private FcpListener connectionClosedListener;
+
        /**
         * Creates an FCP client with the given name.
         *
-        * @param name
-        *            The name of the FCP client
         * @throws UnknownHostException
         *             if the hostname “localhost” is unknown
         */
-       public FcpClient(String name) throws UnknownHostException {
-               this(name, "localhost");
+       public FcpClient() throws UnknownHostException {
+               this("localhost");
        }
 
        /**
         * Creates an FCP client.
         *
-        * @param name
-        *            The name of the FCP client
         * @param hostname
         *            The hostname of the Freenet node
         * @throws UnknownHostException
         *             if the given hostname can not be resolved
         */
-       public FcpClient(String name, String hostname) throws UnknownHostException {
-               this(name, hostname, FcpConnection.DEFAULT_PORT);
+       public FcpClient(String hostname) throws UnknownHostException {
+               this(hostname, FcpConnection.DEFAULT_PORT);
        }
 
        /**
         * Creates an FCP client.
         *
-        * @param name
-        *            The name of the FCP client
         * @param hostname
         *            The hostname of the Freenet node
         * @param port
@@ -130,36 +127,56 @@ public class FcpClient {
         * @throws UnknownHostException
         *             if the given hostname can not be resolved
         */
-       public FcpClient(String name, String hostname, int port) throws UnknownHostException {
-               this(name, InetAddress.getByName(hostname), port);
+       public FcpClient(String hostname, int port) throws UnknownHostException {
+               this(InetAddress.getByName(hostname), port);
        }
 
        /**
         * Creates an FCP client.
         *
-        * @param name
-        *            The name of the FCP client
         * @param host
         *            The host address of the Freenet node
         */
-       public FcpClient(String name, InetAddress host) {
-               this(name, host, FcpConnection.DEFAULT_PORT);
+       public FcpClient(InetAddress host) {
+               this(host, FcpConnection.DEFAULT_PORT);
        }
 
        /**
         * Creates an FCP client.
         *
-        * @param name
-        *            The name of the FCP client
         * @param host
         *            The host address of the Freenet node
         * @param port
         *            The Freenet node’s FCP port
         */
-       public FcpClient(String name, InetAddress host, int port) {
-               this.name = name;
-               fcpConnection = new FcpConnection(host, port);
-               fcpConnection.addFcpListener(new FcpAdapter() {
+       public FcpClient(InetAddress host, int port) {
+               this(new FcpConnection(host, port));
+       }
+
+       /**
+        * Creates a new high-level FCP client that will use the given connection.
+        * This constructor will assume that the FCP connection is already
+        * connected.
+        *
+        * @param fcpConnection
+        *            The FCP connection to use
+        */
+       public FcpClient(FcpConnection fcpConnection) {
+               this(fcpConnection, true);
+       }
+
+       /**
+        * Creates a new high-level FCP client that will use the given connection.
+        *
+        * @param fcpConnection
+        *            The FCP connection to use
+        * @param connected
+        *            The initial status of the FCP connection
+        */
+       public FcpClient(FcpConnection fcpConnection, boolean connected) {
+               this.fcpConnection = fcpConnection;
+               this.connected = connected;
+               connectionClosedListener = new FcpAdapter() {
 
                        /**
                         * {@inheritDoc}
@@ -167,10 +184,11 @@ public class FcpClient {
                        @Override
                        @SuppressWarnings("synthetic-access")
                        public void connectionClosed(FcpConnection fcpConnection, Throwable throwable) {
-                               connected = false;
+                               FcpClient.this.connected = false;
                                fcpClientListenerManager.fireFcpClientDisconnected();
                        }
-               });
+               };
+               fcpConnection.addFcpListener(connectionClosedListener);
        }
 
        //
@@ -218,18 +236,43 @@ public class FcpClient {
        }
 
        //
+       // ACCESSORS
+       //
+
+       /**
+        * Returns the {@link NodeHello} object that the node returned when
+        * connecting.
+        *
+        * @return The {@code NodeHello} data container
+        */
+       public NodeHello getNodeHello() {
+               return nodeHello;
+       }
+
+       /**
+        * Returns the underlying FCP connection.
+        *
+        * @return The underlying FCP connection
+        */
+       public FcpConnection getConnection() {
+               return fcpConnection;
+       }
+
+       //
        // ACTIONS
        //
 
        /**
         * Connects the FCP client.
         *
+        * @param name
+        *            The name of the client
         * @throws IOException
         *             if an I/O error occurs
         * @throws FcpException
         *             if an FCP error occurs
         */
-       public void connect() throws IOException, FcpException {
+       public void connect(final String name) throws IOException, FcpException {
                checkConnected(false);
                connected = true;
                new ExtendedFcpAdapter() {
@@ -251,7 +294,9 @@ public class FcpClient {
                         * {@inheritDoc}
                         */
                        @Override
+                       @SuppressWarnings("synthetic-access")
                        public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) {
+                               FcpClient.this.nodeHello = nodeHello;
                                completionLatch.countDown();
                        }
                }.execute();
@@ -277,6 +322,13 @@ public class FcpClient {
                return connected;
        }
 
+       /**
+        * Detaches this client from its underlying FCP connection.
+        */
+       public void detach() {
+               fcpConnection.removeFcpListener(connectionClosedListener);
+       }
+
        //
        // PEER MANAGEMENT
        //