server: allow closing conn from server action
[fanfix.git] / src / be / nikiroo / utils / serial / server / ConnectActionServer.java
index 60f8db85db4f6f278a9b1f50ef1d41de92b0540e..10d3440e7af4a4a09e5b7cdf06151ab15ac98f66 100644 (file)
@@ -13,6 +13,8 @@ import be.nikiroo.utils.Version;
  * @author niki
  */
 abstract class ConnectActionServer {
+       private boolean closing;
+
        /**
         * The underlying {@link ConnectAction}.
         * <p>
@@ -77,6 +79,32 @@ abstract class ConnectActionServer {
                }).start();
        }
 
+       /**
+        * Stop the client/server connection on behalf of the server (usually, the
+        * client connects then is allowed to send as many requests as it wants; in
+        * some cases, though, the server may wish to forcefully close the
+        * connection and can do via this value, when it is set to TRUE).
+        * <p>
+        * Example of usage: the client failed an authentication check, cut the
+        * connection here and now.
+        */
+       public boolean isClosing() {
+               return closing;
+       }
+
+       /**
+        * Can be called to stop the client/server connection on behalf of the
+        * server (usually, the client connects then is allowed to send as many
+        * requests as it wants; in some cases, though, the server may wish to
+        * forcefully close the connection and can do so by calling this method).
+        * <p>
+        * Example of usage: the client failed an authentication check, cut the
+        * connection here and now.
+        */
+       public void close() {
+               closing = true;
+       }
+
        /**
         * The total amount of bytes received.
         *