diff --git a/build_info.properties b/build_info.properties index 797305a..7b8943f 100644 --- a/build_info.properties +++ b/build_info.properties @@ -1,5 +1,5 @@ -#Sat, 20 Mar 2021 13:27:10 +0100 +#Tue, 15 Jun 2021 12:51:55 +0200 -build.alpha.number=0 +build.alpha.number=1 build.beta.number=1 build.release.number=0 diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html new file mode 100644 index 0000000..e0a87ce --- /dev/null +++ b/doc/allclasses-frame.html @@ -0,0 +1,34 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html new file mode 100644 index 0000000..2978a87 --- /dev/null +++ b/doc/allclasses-noframe.html @@ -0,0 +1,34 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/doc/constant-values.html b/doc/constant-values.html index 3102a8d..321daff 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -1,39 +1,33 @@ - + - + Constant Field Values - - - - + - - - - - - - - + + -
- -
-

Constant Field Values

-

Contents

-
-
- diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index 0fe652a..64eb6c7 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -1,39 +1,33 @@ - + - + Deprecated List - - - - + - - - - - - - - + + -
- -
-

Deprecated API

Contents

-
- diff --git a/doc/dev/bitbite/networking/Client.EventType.html b/doc/dev/bitbite/networking/Client.EventType.html index 51e76ef..4602159 100644 --- a/doc/dev/bitbite/networking/Client.EventType.html +++ b/doc/dev/bitbite/networking/Client.EventType.html @@ -1,49 +1,43 @@ - + - + Client.EventType - - - - + - - - - - - - - + -
- -
-
- -

Enum Client.EventType

+
dev.bitbite.networking
+

Enum Client.EventType

-
java.lang.Object -
java.lang.Enum<Client.EventType> -
dev.bitbite.networking.Client.EventType
-
-
-
+
    +
  • java.lang.Object
  • +
  • +
      +
    • java.lang.Enum<Client.EventType>
    • +
    • +
        +
      • dev.bitbite.networking.Client.EventType
      • +
      +
    • +
    +
  • +
+
+
-
+ + +
+
-
  • -
    +
    +getClass, notify, notifyAll, wait, wait, wait
  • + - -
    + + +
    +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        values

        -
        public static Client.EventType[] values()
        +

        values

        +
        public static Client.EventType[] values()
        Returns an array containing the constants of this enum type, in -the order they are declared.
        +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Client.EventType c : Client.EventType.values())
        +    System.out.println(c);
        +
  • Returns:
    an array containing the constants of this enum type, in the order they are declared
    - + + + + + - - + + + -
    - diff --git a/doc/dev/bitbite/networking/Client.html b/doc/dev/bitbite/networking/Client.html index 98f540d..2d80756 100644 --- a/doc/dev/bitbite/networking/Client.html +++ b/doc/dev/bitbite/networking/Client.html @@ -1,49 +1,43 @@ - + - + Client - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class Client

    +
    dev.bitbite.networking
    +

    Class Client

    -
    java.lang.Object -
    dev.bitbite.networking.Client
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • dev.bitbite.networking.Client
      • +
      +
    • +
    +
    +
      +
    • Direct Known Subclasses:
      -
      SSLClient
      +
      SSLClient

      +
      public abstract class Client
       extends java.lang.Object
      Represents an abstract implementation of the client-side connection.
      - The connection process can be initiated using the client objects connect() method, + The connection process can be initiated using the client objects connect() method, which will return true, if the connection process has been successful.
      - Closing the connection can be done using the client objects close() method, + Closing the connection can be done using the client objects close() method, which will return true, if the disconnection process has been completed successfully.
      - Incoming data from the server will be forwarded to processReceivedData(String).
      - Data to the server can be sent using the clients IOHandler.
      - Some events trigger the notification of registered ClientListeners.
      + Incoming data from the server will be forwarded to processReceivedData(String).
      + Data to the server can be sent using the clients IOHandler.
      + Some events trigger the notification of registered ClientListeners.
    Version:
    0.0.1-alpha
    See Also:
    -
    ClientListener
    +
    ClientListener
    -
    -
    + + +
    +
    -
  • -
    +
  • + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - - - -
      Constructors 
      ConstructorDescriptionConstructor and Description
      Client​(java.lang.String host, -int port) +Client(java.lang.String host, + int port)
      Creates a Client object and sets the endpoint on which on startup the client will try to connect to
      Client​(java.net.URL url) +Client(java.net.URL url)
      Creates a Client object and sets the endpoint to which the client will connect on startup.
      -
      -
  • + -
  • -
    +
    + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • + + + - -
    +
    +
    -
  • -
    +
      +
    • + + +

      Constructor Detail

      + -

      Constructor Details

      • -
        -

        Client

        -
        public Client​(java.lang.String host, -int port)
        +

        Client

        +
        public Client(java.lang.String host,
        +              int port)
        Creates a Client object and sets the endpoint on which on startup the client will try to connect to
        @@ -435,33 +417,37 @@

        Client

        host - the domain or IP-adress without protocoll information or port
        port - to connect to
        -
      • +
      + + + +
      • -
        -

        Client

        -
        public Client​(java.net.URL url)
        +

        Client

        +
        public Client(java.net.URL url)
        Creates a Client object and sets the endpoint to which the client will connect on startup.
        Parameters:
        url - the URL object that specifies the endpoint adress and port.
        -
      -
  • + -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        connect

        -
        public boolean connect()
        +

        connect

        +
        public boolean connect()
        Initiates the connection process.
        The IOHandler will be created. Listeners will be called before the client tries to connect to the server, @@ -470,14 +456,17 @@

        connect

        Returns:
        true if the connection process as been completed successfully
        -
      • +
      + + + +
      • -
        -

        openSocket

        -
        protected void openSocket() - throws java.net.UnknownHostException, -java.io.IOException
        +

        openSocket

        +
        protected void openSocket()
        +                   throws java.net.UnknownHostException,
        +                          java.io.IOException
        Opens the Socket connection. Moved to a different function to make it easier to replace the Socket implementation.
        @@ -485,12 +474,15 @@

        openSocket

        java.net.UnknownHostException - if the specified Host is unknown
        java.io.IOException - when the process of opening the Socket fails.
        -
      • +
      + + + +
      • -
        -

        close

        -
        public boolean close()
        +

        close

        +
        public boolean close()
        Closes the connection.
        Listeners will be called before the disconnection process is started and when it succeeded or failed.
        @@ -499,81 +491,102 @@

        close

        Returns:
        true if the connection has been closed successfully
        See Also:
        -
        IOHandler.close()
        +
        IOHandler.close()
        -
      • +
      + + + +
      • -
        -

        send

        -
        public void send​(java.lang.String data)
        +

        send

        +
        public void send(java.lang.String data)
        Sends data to the Server
        Parameters:
        data - to send
        -
      • +
      + + + +
      • -
        -

        processReceivedData

        -
        protected abstract void processReceivedData​(java.lang.String data)
        +

        processReceivedData

        +
        protected abstract void processReceivedData(java.lang.String data)
        This function will be called once the client receives data from the server.
        Parameters:
        data - sent by the server
        -
      • +
      + + + + + + + + + + + +
      • -
        -

        removeListener

        -
        public void removeListener​(ClientListener listener)
        +

        removeListener

        +
        public void removeListener(ClientListener listener)
        Removes ClientListener from the listeners
        Parameters:
        listener - to remove
        -
      • +
      + + + + + + + + + + + +
      • -
        -

        isConnected

        -
        public boolean isConnected()
        +

        isConnected

        +
        public boolean isConnected()
        Indicates whether the current client object has an active connection to the server
        Returns:
        true if there is an active connection to the server
        -
      • +
      + + + +
      • -
        -

        getIOHandler

        -
        public IOHandler getIOHandler()
        +

        getIOHandler

        +
        public IOHandler getIOHandler()
        Returns the IOHandler associated with the client object
        Returns:
        the IOHandler
        -
      -
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/ClientListener.html b/doc/dev/bitbite/networking/ClientListener.html index 9724ce8..645bf4e 100644 --- a/doc/dev/bitbite/networking/ClientListener.html +++ b/doc/dev/bitbite/networking/ClientListener.html @@ -1,49 +1,43 @@ - + - + ClientListener - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class ClientListener

    +
    dev.bitbite.networking
    +

    Class ClientListener

    -
    java.lang.Object -
    dev.bitbite.networking.ClientListener
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • dev.bitbite.networking.ClientListener
      • +
      +
    • +
    +
    +
      +

    • +
      public abstract class ClientListener
       extends java.lang.Object
      This class contains all functions which, if registered at the client object, will be called @@ -105,204 +116,203 @@

      Class ClientListener

      Version:
      0.0.1-alpha
      See Also:
      -
      Client
      +
      Client
      -
    -
    + + +
    +
    -
  • -
    +
    + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • + - -
    + + +
    +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        onConnectionCreation

        -
        public void onConnectionCreation()
        +

        onConnectionCreation

        +
        public void onConnectionCreation()
        Will be called before the Client tries to connect to the server
        -
      • +
      + + + +
      • -
        -

        onConnectionSuccess

        -
        public void onConnectionSuccess()
        +

        onConnectionSuccess

        +
        public void onConnectionSuccess()
        Will be called if the connection to the server was successful
        -
      • +
      + + + +
      • -
        -

        onConnectionFailed

        -
        public void onConnectionFailed​(java.lang.Exception e)
        +

        onConnectionFailed

        +
        public void onConnectionFailed(java.lang.Exception e)
        Will be called if an error occured while trying to connect to the server
        Parameters:
        e - the exception which was thrown
        -
      • +
      + + + +
      • -
        -

        onCloseRequested

        -
        public void onCloseRequested()
        +

        onCloseRequested

        +
        public void onCloseRequested()
        Will be called before the disconnection and closing processes being initiated
        -
      • +
      + + + +
      • -
        -

        onCloseSuccess

        -
        public void onCloseSuccess()
        +

        onCloseSuccess

        +
        public void onCloseSuccess()
        Will be called after finishing the disconnection process
        -
      • +
      + + + +
      • -
        -

        onCloseFailed

        -
        public void onCloseFailed​(java.lang.Exception e)
        +

        onCloseFailed

        +
        public void onCloseFailed(java.lang.Exception e)
        Will be called if the disconnection and closing process failed
        Parameters:
        e - the exception which was thrown
        -
      -
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/ClientManager.html b/doc/dev/bitbite/networking/ClientManager.html index abcc108..7487cd6 100644 --- a/doc/dev/bitbite/networking/ClientManager.html +++ b/doc/dev/bitbite/networking/ClientManager.html @@ -1,49 +1,43 @@ - + - + ClientManager - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class ClientManager

    +
    dev.bitbite.networking
    +

    Class ClientManager

    -
    java.lang.Object -
    java.lang.Thread -
    dev.bitbite.networking.ClientManager
    -
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • java.lang.Thread
      • +
      • +
          +
        • dev.bitbite.networking.ClientManager
        • +
        +
      • +
      +
    • +
    +
    +
      +
    • All Implemented Interfaces:
      -
      java.lang.Runnable
      +
      java.lang.Runnable

      +
      public class ClientManager
       extends java.lang.Thread
      Administrates the clients an runs in its own Thread. It accepts them from the serversocket and - starts a CommunicationHandler in a separate thread for each connecting client.
      + starts a CommunicationHandler in a separate thread for each connecting client.
    Version:
    0.0.1-alpha
    See Also:
    -
    CommunicationHandler
    +
    CommunicationHandler
    -
    -
    + + +
    +
    + -
  • -
    +
    + +

    Fields inherited from class java.lang.Thread

    +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
  • + + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - -
      Constructors 
      ConstructorDescriptionConstructor and Description
      ClientManager​(Server server) +ClientManager(Server server)
      Initiates a ClientManager object
      -
      -
  • + -
  • -
    +
    +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • + + + - -
    +
    +
    -
  • -
    +
      +
    • -

      Constructor Details

      -
        +

        Constructor Detail

        + + + +
        • -
          -

          ClientManager

          -
          public ClientManager​(Server server)
          +

          ClientManager

          +
          public ClientManager(Server server)
          Initiates a ClientManager object
          Parameters:
          server - that it should manage clients for
          -
        -
  • + -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        run

        -
        public void run()
        +

        run

        +
        public void run()
        Starts the process of accepting clients to the server. For each client that is accepted - a CommunicationHandler is started in a separate Thread.
        + a CommunicationHandler is started in a separate Thread.
  • Specified by:
    run in interface java.lang.Runnable
    Overrides:
    run in class java.lang.Thread
    See Also:
    -
    CommunicationHandler
    +
    CommunicationHandler
    - + + + + + + + + + + + + + + + + + - - + + + -
    - diff --git a/doc/dev/bitbite/networking/CommunicationHandler.html b/doc/dev/bitbite/networking/CommunicationHandler.html index 6b63192..202025a 100644 --- a/doc/dev/bitbite/networking/CommunicationHandler.html +++ b/doc/dev/bitbite/networking/CommunicationHandler.html @@ -1,49 +1,43 @@ - + - + CommunicationHandler - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class CommunicationHandler

    +
    dev.bitbite.networking
    +

    Class CommunicationHandler

    -
    java.lang.Object -
    java.lang.Thread -
    dev.bitbite.networking.CommunicationHandler
    -
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • java.lang.Thread
      • +
      • +
          +
        • dev.bitbite.networking.CommunicationHandler
        • +
        +
      • +
      +
    • +
    +
    +
      +
    • All Implemented Interfaces:
      -
      java.lang.Runnable
      +
      java.lang.Runnable

      +
      public class CommunicationHandler
       extends java.lang.Thread
      Manages the Communication with a client by handling its IO. @@ -111,311 +125,313 @@

      Class CommunicationHandler<
      Version:
      0.0.1-alpha
      -

    -
    + + +
    +
    + -
  • -
    +
    + +

    Fields inherited from class java.lang.Thread

    +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
  • + + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - -
      Constructors 
      ConstructorDescriptionConstructor and Description
      CommunicationHandler​(java.net.Socket clientSocket, -ClientManager clientManager) +CommunicationHandler(java.net.Socket clientSocket, + ClientManager clientManager)
      Creates a CommunicationHandler object for a socket
      -
      -
  • + -
  • -
    +
    +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • + - -
    + + +
    +
    -
  • -
    +
      +
    • -

      Constructor Details

      -
        +

        Constructor Detail

        + + + +
        • -
          -

          CommunicationHandler

          -
          public CommunicationHandler​(java.net.Socket clientSocket, -ClientManager clientManager)
          +

          CommunicationHandler

          +
          public CommunicationHandler(java.net.Socket clientSocket,
          +                            ClientManager clientManager)
          Creates a CommunicationHandler object for a socket
          Parameters:
          clientSocket - which IO should be handled
          clientManager - the clientManager of the server which accepted the client
          -
        -
  • + -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        close

        -
        public void close()
        +

        close

        +
        public void close()
        Closes the IOStreams and the socket itself.
        -
      • +
      + + + +
      • -
        -

        send

        -
        protected void send​(java.lang.String data)
        +

        send

        +
        protected void send(java.lang.String data)
        Sends data to the client
        Parameters:
        data - to send
        -
      • +
      + + + +
      • -
        -

        processReceivedData

        -
        protected void processReceivedData​(java.lang.String data)
        +

        processReceivedData

        +
        protected void processReceivedData(java.lang.String data)
        Gets called by the IOHandler when data is received from the client. - It lets the DataPreProcessor process the data and then + It lets the DataPreProcessor process the data and then forwards the data to the server.
        Parameters:
        data - received from the client
        -
      • +
      + + + + + + + +
      • -
        -

        registerListener

        -
        public void registerListener​(java.util.ArrayList<IOHandlerListener> listener)
        +

        registerListener

        +
        public void registerListener(java.util.ArrayList<IOHandlerListener> listener)
        Registers a list of listeners to the underlying IOHandler
        Parameters:
        listener - to add
        -
      • +
      + + + +
      • -
        -

        getIP

        -
        public java.lang.String getIP()
        +

        getIP

        +
        public java.lang.String getIP()
        Returns:
        the remote socket address of the associated client socket
        -
      -
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/DataPreProcessor.TransferMode.html b/doc/dev/bitbite/networking/DataPreProcessor.TransferMode.html index 18f9401..dd55e66 100644 --- a/doc/dev/bitbite/networking/DataPreProcessor.TransferMode.html +++ b/doc/dev/bitbite/networking/DataPreProcessor.TransferMode.html @@ -1,49 +1,43 @@ - + - + DataPreProcessor.TransferMode - - - - + - - - - - - - - + -
    - -
    -
    - -

    Enum DataPreProcessor.TransferMode

    +
    dev.bitbite.networking
    +

    Enum DataPreProcessor.TransferMode

    -
    java.lang.Object -
    java.lang.Enum<DataPreProcessor.TransferMode> -
    dev.bitbite.networking.DataPreProcessor.TransferMode
    -
    -
    -
    + +
    +
    -
    + + +
    +
    -
  • -
    +
    +getClass, notify, notifyAll, wait, wait, wait
  • + - -
    + + +
    +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        values

        -
        public static DataPreProcessor.TransferMode[] values()
        +

        values

        +
        public static DataPreProcessor.TransferMode[] values()
        Returns an array containing the constants of this enum type, in -the order they are declared.
        +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (DataPreProcessor.TransferMode c : DataPreProcessor.TransferMode.values())
        +    System.out.println(c);
        +
  • Returns:
    an array containing the constants of this enum type, in the order they are declared
    - + + + + + - - + + + -
    - diff --git a/doc/dev/bitbite/networking/DataPreProcessor.html b/doc/dev/bitbite/networking/DataPreProcessor.html index cee459c..a5dceaf 100644 --- a/doc/dev/bitbite/networking/DataPreProcessor.html +++ b/doc/dev/bitbite/networking/DataPreProcessor.html @@ -1,49 +1,43 @@ - + - + DataPreProcessor - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class DataPreProcessor

    +
    dev.bitbite.networking
    +

    Class DataPreProcessor

    -
    java.lang.Object -
    dev.bitbite.networking.DataPreProcessor
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • dev.bitbite.networking.DataPreProcessor
      • +
      +
    • +
    +
    +
    -
    + + +
    +
    -
  • -
    +
  • + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - -
      Constructors 
      ModifierConstructorDescriptionConstructor and Description
      protected DataPreProcessor() +DataPreProcessor()
      Instantiates the DataPreProcessor
      -
      -
  • + -
  • -
    +
    + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • + + + - -
    +
    +
    -
  • -
    +
      +
    • -

      Constructor Details

      -
        +

        Constructor Detail

        + + + +
        • -
          -

          DataPreProcessor

          -
          protected DataPreProcessor()
          +

          DataPreProcessor

          +
          protected DataPreProcessor()
          Instantiates the DataPreProcessor
          -
        -
  • + -
  • -
    +
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/DataProcessingLayer.html b/doc/dev/bitbite/networking/DataProcessingLayer.html index de8122c..776f1f9 100644 --- a/doc/dev/bitbite/networking/DataProcessingLayer.html +++ b/doc/dev/bitbite/networking/DataProcessingLayer.html @@ -1,49 +1,43 @@ - + - + DataProcessingLayer - - - - + - - - - - - - - + -
    - -
    -
    - -

    Interface DataProcessingLayer

    +
    dev.bitbite.networking
    +

    Interface DataProcessingLayer

    -
    +
    +
      +
    • Functional Interface:
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

      +
      @FunctionalInterface
       public interface DataProcessingLayer
      Represents a single data processing layer. Incoming data will be processed - by process(String) and its result will be returned.
      + by process(String) and its result will be returned.
    Version:
    0.0.2-alpha
    -
    -
    + + +
    +
    - -
    + + +
    +
    - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/IOHandler.EventType.html b/doc/dev/bitbite/networking/IOHandler.EventType.html index cb206f8..889fb88 100644 --- a/doc/dev/bitbite/networking/IOHandler.EventType.html +++ b/doc/dev/bitbite/networking/IOHandler.EventType.html @@ -1,49 +1,43 @@ - + - + IOHandler.EventType - - - - + - - - - - - - - + -
    - -
    -
    - -

    Enum IOHandler.EventType

    +
    dev.bitbite.networking
    +

    Enum IOHandler.EventType

    -
    java.lang.Object -
    java.lang.Enum<IOHandler.EventType> -
    dev.bitbite.networking.IOHandler.EventType
    -
    -
    -
    +
      +
    • java.lang.Object
    • +
    • + +
    • +
    +
    +
    -
    + + +
    +
    -
  • -
    +
    +getClass, notify, notifyAll, wait, wait, wait
  • + + + - -
    +
    +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        values

        -
        public static IOHandler.EventType[] values()
        +

        values

        +
        public static IOHandler.EventType[] values()
        Returns an array containing the constants of this enum type, in -the order they are declared.
        +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (IOHandler.EventType c : IOHandler.EventType.values())
        +    System.out.println(c);
        +
  • Returns:
    an array containing the constants of this enum type, in the order they are declared
    - + + + + + - - + + + -
    - diff --git a/doc/dev/bitbite/networking/IOHandler.html b/doc/dev/bitbite/networking/IOHandler.html index d1958ef..25e8ec6 100644 --- a/doc/dev/bitbite/networking/IOHandler.html +++ b/doc/dev/bitbite/networking/IOHandler.html @@ -1,49 +1,43 @@ - + - + IOHandler - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class IOHandler

    +
    dev.bitbite.networking
    +

    Class IOHandler

    -
    java.lang.Object -
    dev.bitbite.networking.IOHandler
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • dev.bitbite.networking.IOHandler
      • +
      +
    • +
    +
    +
      +

    • +
      public class IOHandler
       extends java.lang.Object
      This IOHandler class combines an input- and an output stream object into a single class. Incoming data of the inputstream will be propagated to the onRead consumer method passed as an argument to the constructor.
      - You can write to the outputstream via write(String)
      + You can write to the outputstream via write(String)

      For the process of reading incoming data from the InputStream a Thread is started and named "IO InputListener"
      Version:
      0.0.2-alpha
      -
    -
    + + +
    +
    -
  • -
    +
  • + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - -
      Constructors 
      ConstructorDescriptionConstructor and Description
      IOHandler​(java.io.InputStream inputStream, -java.io.OutputStream outputStream, -java.util.function.Consumer<java.lang.String> onRead) -
      Initializes the IOHandler with the given Streams and read-Callback method.
      - It also starts a Thread which listens for incoming data from the inputStream.
      +
      IOHandler(java.io.InputStream inputStream, + java.io.OutputStream outputStream, + java.util.function.Consumer<java.lang.String> onRead) +
      Initializes the IOHandler with the given Streams and read-Callback method.
      -
      -
  • + -
  • -
    +
    + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • + - -
    + + +
    +
    -
  • -
    +
      +
    • -

      Constructor Details

      -
        +

        Constructor Detail

        + + + +
        • -
          -

          IOHandler

          -
          public IOHandler​(java.io.InputStream inputStream, -java.io.OutputStream outputStream, -java.util.function.Consumer<java.lang.String> onRead)
          +

          IOHandler

          +
          public IOHandler(java.io.InputStream inputStream,
          +                 java.io.OutputStream outputStream,
          +                 java.util.function.Consumer<java.lang.String> onRead)
          Initializes the IOHandler with the given Streams and read-Callback method.
          It also starts a Thread which listens for incoming data from the inputStream. That is done so the IOHandler is non-blocking.
          Parameters:
          -
          inputStream - , the inputStream to read the data from
          -
          outputStream - , the outputStream to write to
          -
          onRead - , the read Callback method which is called when a message is received
          +
          inputStream, - the inputStream to read the data from
          +
          outputStream, - the outputStream to write to
          +
          onRead, - the read Callback method which is called when a message is received
          Throws:
          java.lang.IllegalArgumentException - if at least one of the supplied arguments is null
          -
        -
  • + -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        close

        -
        public void close() - throws java.io.IOException
        +

        close

        +
        public void close()
        +           throws java.io.IOException
        Closes the streams
        Throws:
        java.io.IOException - if any closing fails
        -
      • +
      + + + +
      • -
        -

        write

        -
        public void write​(java.lang.String data)
        +

        write

        +
        public void write(java.lang.String data)
        Writes data to the OutputStream and flushes it.
        Parameters:
        @@ -376,35 +367,44 @@

        write

        See Also:
        PrintWriter
        -
      • +
      + + + + + + + + + + + + -
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/IOHandlerListener.html b/doc/dev/bitbite/networking/IOHandlerListener.html index 467b366..cd6820a 100644 --- a/doc/dev/bitbite/networking/IOHandlerListener.html +++ b/doc/dev/bitbite/networking/IOHandlerListener.html @@ -1,49 +1,43 @@ - + - + IOHandlerListener - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class IOHandlerListener

    +
    dev.bitbite.networking
    +

    Class IOHandlerListener

    -
    java.lang.Object -
    dev.bitbite.networking.IOHandlerListener
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • dev.bitbite.networking.IOHandlerListener
      • +
      +
    • +
    +
    +
      +

    • +
      public abstract class IOHandlerListener
       extends java.lang.Object
      This class contains all functions which, if registered at the IOHandler object, will be called @@ -105,256 +116,261 @@

      Class IOHandlerListener

      Version:
      0.0.1-alpha
      See Also:
      -
      IOHandler
      +
      IOHandler
      -
    -
    + + +
    +
    -
  • -
    +
      +
    • -

      Method Summary

      -
      -
      -
      - - +

      Method Summary

      +
      + - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescriptionMethod and Description
      voidonCloseEnd() +onCloseEnd()
      Will be called once the streams have been closed
      voidonCloseFailed​(java.lang.Exception exception) +onCloseFailed(java.lang.Exception exception)
      Will be called if an error occurs while trying to close the streams
      voidonCloseStart() +onCloseStart()
      Will be called before the closing of the streams is started
      voidonDataReadEnd() +onDataReadEnd()
      Will be called once the process of reading data from the inputStream ends
      voidonDataReadFailed​(java.lang.Exception exception) +onDataReadFailed(java.lang.Exception exception)
      Will be called if an error occurs while trying to read data from the inputStream
      voidonDataReadStart() +onDataReadStart()
      Will be called before the process of reading data from the inputStream is being started
      voidonWrite​(java.lang.String data) +onWrite(java.lang.String data)
      Will be called before data is sent over the outputStream
      voidonWriteEnd() +onWriteEnd()
      Will be called after the writing to the outputStream has been finished
      voidonWriteFailed​(java.lang.Exception exception) +onWriteFailed(java.lang.Exception exception)
      Will be called if the writing the data to the outputStream fails
      -
      -
      -
      -

      Methods inherited from class java.lang.Object

      - +
        +
      • -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      -
    + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • + - -
    + + +
    +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        onDataReadStart

        -
        public void onDataReadStart()
        +

        onDataReadStart

        +
        public void onDataReadStart()
        Will be called before the process of reading data from the inputStream is being started
        -
      • +
      + + + +
      • -
        -

        onDataReadEnd

        -
        public void onDataReadEnd()
        +

        onDataReadEnd

        +
        public void onDataReadEnd()
        Will be called once the process of reading data from the inputStream ends
        -
      • +
      + + + +
      • -
        -

        onDataReadFailed

        -
        public void onDataReadFailed​(java.lang.Exception exception)
        +

        onDataReadFailed

        +
        public void onDataReadFailed(java.lang.Exception exception)
        Will be called if an error occurs while trying to read data from the inputStream
        Parameters:
        exception - which was thrown
        -
      • +
      + + + +
      • -
        -

        onCloseStart

        -
        public void onCloseStart()
        +

        onCloseStart

        +
        public void onCloseStart()
        Will be called before the closing of the streams is started
        -
      • +
      + + + +
      • -
        -

        onCloseEnd

        -
        public void onCloseEnd()
        +

        onCloseEnd

        +
        public void onCloseEnd()
        Will be called once the streams have been closed
        -
      • +
      + + + +
      • -
        -

        onCloseFailed

        -
        public void onCloseFailed​(java.lang.Exception exception)
        +

        onCloseFailed

        +
        public void onCloseFailed(java.lang.Exception exception)
        Will be called if an error occurs while trying to close the streams
        Parameters:
        exception - which was thrown during the process
        -
      • +
      + + + +
      • -
        -

        onWrite

        -
        public void onWrite​(java.lang.String data)
        +

        onWrite

        +
        public void onWrite(java.lang.String data)
        Will be called before data is sent over the outputStream
        Parameters:
        data - which will be sent
        -
      • +
      + + + +
      • -
        -

        onWriteEnd

        -
        public void onWriteEnd()
        +

        onWriteEnd

        +
        public void onWriteEnd()
        Will be called after the writing to the outputStream has been finished
        -
      • +
      + + + +
      • -
        -

        onWriteFailed

        -
        public void onWriteFailed​(java.lang.Exception exception)
        +

        onWriteFailed

        +
        public void onWriteFailed(java.lang.Exception exception)
        Will be called if the writing the data to the outputStream fails
        Parameters:
        exception - which was thrown while trying to send the data
        -
      -
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/SSLClient.html b/doc/dev/bitbite/networking/SSLClient.html index 5b5b585..b87d69d 100644 --- a/doc/dev/bitbite/networking/SSLClient.html +++ b/doc/dev/bitbite/networking/SSLClient.html @@ -1,49 +1,43 @@ - + - + SSLClient - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class SSLClient

    +
    dev.bitbite.networking
    +

    Class SSLClient

    -
    java.lang.Object -
    dev.bitbite.networking.Client -
    dev.bitbite.networking.SSLClient
    -
    -
    -
    + +
    +
      +

    • +
      public abstract class SSLClient
      -extends Client
      -
    -
    +extends Client + + +
    +
    + -
  • -
    +
    + +

    Fields inherited from class dev.bitbite.networking.Client

    +HOST, PORT, socket
  • + + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - + -
      Constructors 
      ConstructorDescriptionConstructor and Description
      SSLClient​(java.lang.String host, -int port) SSLClient(java.lang.String host, + int port) 
      -
      -
  • + -
  • -
    + +
      +
    • -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • - + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait + - -
    + + + +
      -
    • -
      + +
        +
      • -

        Constructor Details

        -
          +

          Constructor Detail

          + + + +
          • -
            -

            SSLClient

            -
            public SSLClient​(java.lang.String host, -int port)
            -
            +

            SSLClient

            +
            public SSLClient(java.lang.String host,
            +                 int port)
          -
    • +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        openSocket

        -
        protected void openSocket() - throws java.net.UnknownHostException, -java.io.IOException
        -
        Description copied from class: Client
        +

        openSocket

        +
        protected void openSocket()
        +                   throws java.net.UnknownHostException,
        +                          java.io.IOException
        +
        Description copied from class: Client
        Opens the Socket connection. Moved to a different function to make it easier to replace the Socket implementation.
        Overrides:
        -
        openSocket in class Client
        +
        openSocket in class Client
        Throws:
        java.net.UnknownHostException - if the specified Host is unknown
        java.io.IOException - when the process of opening the Socket fails.
        -
      • +
      + + + +
      • -
        -

        processReceivedData

        -
        protected abstract void processReceivedData​(java.lang.String data)
        -
        Description copied from class: Client
        +

        processReceivedData

        +
        protected abstract void processReceivedData(java.lang.String data)
        +
        Description copied from class: Client
        This function will be called once the client receives data from the server.
        Specified by:
        -
        processReceivedData in class Client
        +
        processReceivedData in class Client
        Parameters:
        data - sent by the server
        -
      -
  • -
    + + + -
    - diff --git a/doc/dev/bitbite/networking/SSLServer.html b/doc/dev/bitbite/networking/SSLServer.html index 74c72a7..182f026 100644 --- a/doc/dev/bitbite/networking/SSLServer.html +++ b/doc/dev/bitbite/networking/SSLServer.html @@ -1,49 +1,43 @@ - + - + SSLServer - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class SSLServer

    +
    dev.bitbite.networking
    +

    Class SSLServer

    -
    java.lang.Object -
    dev.bitbite.networking.Server -
    dev.bitbite.networking.SSLServer
    -
    -
    -
    + +
    +
      +

    • +
      public abstract class SSLServer
      -extends Server
      -
    -
    +extends Server + + +
    +
    + -
  • -
    +
    + +

    Fields inherited from class dev.bitbite.networking.Server

    +clientManager, dataPreProcessor, ioListeners, listeners, PORT, serverSocket
  • + + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - + -
      Constructors 
      ConstructorDescriptionConstructor and Description
      SSLServer​(int port) SSLServer(int port) 
      -
      -
  • + -
  • -
    + +
      +
    • -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • - + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait + - -
    + + + +
      -
    • -
      + +
        +
      • -

        Constructor Details

        -
          +

          Constructor Detail

          + + + +
          • -
            -

            SSLServer

            -
            public SSLServer​(int port)
            -
            +

            SSLServer

            +
            public SSLServer(int port)
          -
    • +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        openServerSocket

        -
        protected void openServerSocket()
        -
        Description copied from class: Server
        +

        openServerSocket

        +
        protected void openServerSocket()
        +
        Description copied from class: Server
        Opens the ServerSocket. Moved to a different function to make it easier to replace the ServerSocket implementation.
        Overrides:
        -
        openServerSocket in class Server
        +
        openServerSocket in class Server
        -
      • +
      + + + +
      • -
        -

        processReceivedData

        -
        protected abstract void processReceivedData​(java.lang.String clientAddress, -java.lang.String data)
        -
        Description copied from class: Server
        +

        processReceivedData

        +
        protected abstract void processReceivedData(java.lang.String clientAddress,
        +                                            java.lang.String data)
        +
        Description copied from class: Server
        This function will be called once the server receives data from the client.
        Specified by:
        -
        processReceivedData in class Server
        +
        processReceivedData in class Server
        Parameters:
        clientAddress - of the client the data came from
        data - sent by the server
        -
      -
  • -
    + + + -
    - diff --git a/doc/dev/bitbite/networking/Server.EventType.html b/doc/dev/bitbite/networking/Server.EventType.html index a26e541..2af1c15 100644 --- a/doc/dev/bitbite/networking/Server.EventType.html +++ b/doc/dev/bitbite/networking/Server.EventType.html @@ -1,49 +1,43 @@ - + - + Server.EventType - - - - + - - - - - - - - + -
    - -
    -
    - -

    Enum Server.EventType

    +
    dev.bitbite.networking
    +

    Enum Server.EventType

    -
    java.lang.Object -
    java.lang.Enum<Server.EventType> -
    dev.bitbite.networking.Server.EventType
    -
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • java.lang.Enum<Server.EventType>
      • +
      • +
          +
        • dev.bitbite.networking.Server.EventType
        • +
        +
      • +
      +
    • +
    +
    +
    -
    + + +
    +
    -
  • -
    +
    +getClass, notify, notifyAll, wait, wait, wait
  • + - -
    + + +
    +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        values

        -
        public static Server.EventType[] values()
        +

        values

        +
        public static Server.EventType[] values()
        Returns an array containing the constants of this enum type, in -the order they are declared.
        +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Server.EventType c : Server.EventType.values())
        +    System.out.println(c);
        +
  • Returns:
    an array containing the constants of this enum type, in the order they are declared
    - + + + + + - - + + + -
    - diff --git a/doc/dev/bitbite/networking/Server.html b/doc/dev/bitbite/networking/Server.html index e6b3459..3230133 100644 --- a/doc/dev/bitbite/networking/Server.html +++ b/doc/dev/bitbite/networking/Server.html @@ -1,49 +1,43 @@ - + - + Server - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class Server

    +
    dev.bitbite.networking
    +

    Class Server

    -
    java.lang.Object -
    dev.bitbite.networking.Server
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • dev.bitbite.networking.Server
      • +
      +
    • +
    +
    +
    Version:
    0.0.2-alpha
    See Also:
    -
    ClientManager, -CommunicationHandler, -DataProcessingLayer, -DataPreProcessor
    +
    ClientManager, +CommunicationHandler, +DataProcessingLayer, +DataPreProcessor
    -
    -
    + + +
    +
    -
  • -
    +
  • + -
  • -
    +
      +
    • -

      Constructor Summary

      -
      - +

      Constructor Summary

      +
      - - - + - - - - -
      Constructors 
      ConstructorDescriptionConstructor and Description
      Server​(int port) +Server(int port)
      Creates a server object and sets the port the server will try to listen on
      -
      -
  • + -
  • -
    +
    + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • + + + - -
    +
    +
    -
  • -
    +
      +
    • -

      Constructor Details

      -
        +

        Constructor Detail

        + + + +
        • -
          -

          Server

          -
          public Server​(int port)
          +

          Server

          +
          public Server(int port)
          Creates a server object and sets the port the server will try to listen on
          Parameters:
          port - to listen on
          -
        -
  • + -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        start

        -
        public void start()
        -
        Opens a ServerSocket, initializes the DataProcessingLayers and starts listening on the specified port
        -
        +

        start

        +
        public void start()
        +
        Opens a ServerSocket, initializes the DataProcessingLayers and starts listening on the specified port
      • +
      + + + +
      • -
        -

        openServerSocket

        -
        protected void openServerSocket() - throws java.io.IOException
        +

        openServerSocket

        +
        protected void openServerSocket()
        +                         throws java.io.IOException
        Opens the ServerSocket. Moved to a different function to make it easier to replace the ServerSocket implementation.
        Throws:
        java.io.IOException - when the process of opening the ServerSocket fails.
        -
      • +
      + + + + + + + +
      • -
        -

        processReceivedData

        -
        protected abstract void processReceivedData​(java.lang.String clientAddress, -java.lang.String data)
        +

        processReceivedData

        +
        protected abstract void processReceivedData(java.lang.String clientAddress,
        +                                            java.lang.String data)
        This function will be called once the server receives data from the client.
        Parameters:
        clientAddress - of the client the data came from
        data - sent by the server
        -
      • +
      + + + +
      • -
        -

        send

        -
        public boolean send​(java.lang.String clientAddress, -java.lang.String data)
        -
        +

        send

        +
        public boolean send(java.lang.String clientAddress,
        +                    java.lang.String data)
      • +
      + + + +
      • -
        -

        broadcast

        -
        public void broadcast​(java.lang.String data)
        +

        broadcast

        +
        public void broadcast(java.lang.String data)
        Sends the data to all connected clients.
        Parameters:
        data - to broadcast
        -
      • +
      + + + + + + + + + + + +
      • -
        -

        removeListener

        -
        public void removeListener​(ServerListener listener)
        +

        removeListener

        +
        public void removeListener(ServerListener listener)
        Removes ClientListener from the listeners
        Parameters:
        listener - to remove
        -
      • +
      + + + + + + + + + + + +
      • -
        -

        getServerSocket

        -
        protected java.net.ServerSocket getServerSocket()
        +

        getServerSocket

        +
        protected java.net.ServerSocket getServerSocket()
        Returns the current ServerSocket
        Returns:
        the current ServerSocket
        -
      • +
      + + + +
      • -
        -

        getServerListeners

        -
        public java.util.ArrayList<ServerListener> getServerListeners()
        +

        getServerListeners

        +
        public java.util.ArrayList<ServerListener> getServerListeners()
        Returns a list of all ServerListeners registered at the server
        Returns:
        the list of ServerListeners
        -
      • +
      + + + +
      • -
        -

        getIOHandlerListeners

        -
        public java.util.ArrayList<IOHandlerListener> getIOHandlerListeners()
        +

        getIOHandlerListeners

        +
        public java.util.ArrayList<IOHandlerListener> getIOHandlerListeners()
        Returns a list of all IOHandlers registered at the server
        Returns:
        the list of IOHandlers
        -
      • +
      + + + +
      • -
        -

        getDataPreProcessor

        -
        protected DataPreProcessor getDataPreProcessor()
        +

        getDataPreProcessor

        +
        protected DataPreProcessor getDataPreProcessor()
        Returns the DataPreProcessor of this server object.
        Returns:
        the DataPreProcessor of this server object
        -
      -
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/ServerListener.html b/doc/dev/bitbite/networking/ServerListener.html index ef04c97..1d57913 100644 --- a/doc/dev/bitbite/networking/ServerListener.html +++ b/doc/dev/bitbite/networking/ServerListener.html @@ -1,49 +1,43 @@ - + - + ServerListener - - - - + - - - - - - - - + -
    - -
    -
    - -

    Class ServerListener

    +
    dev.bitbite.networking
    +

    Class ServerListener

    -
    java.lang.Object -
    dev.bitbite.networking.ServerListener
    -
    -
    +
      +
    • java.lang.Object
    • +
    • +
        +
      • dev.bitbite.networking.ServerListener
      • +
      +
    • +
    +
    +
      +

    • +
      public abstract class ServerListener
       extends java.lang.Object
      This class contains all functions which, if registered at the server object, will be called @@ -105,350 +116,390 @@

      Class ServerListener

      Version:
      0.0.1-alpha
      See Also:
      -
      Server
      +
      Server
      -
    -
    + + +
    +
    -
  • -
    +
    + +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • + + + - -
    +
    +
    -
  • -
    +
      +
    • + + +

      Method Detail

      + -

      Method Details

      • -
        -

        onStart

        -
        public void onStart()
        +

        onStart

        +
        public void onStart()
        Will be called before server startup
        -
      • +
      + + + +
      • -
        -

        onStartFailed

        -
        public void onStartFailed​(java.lang.Exception e)
        +

        onStartFailed

        +
        public void onStartFailed(java.lang.Exception e)
        Will be called if server start failed
        Parameters:
        e - the exception thrown while trying to start the server
        -
      • +
      + + + +
      • -
        -

        onStartSuccess

        -
        public void onStartSuccess()
        +

        onStartSuccess

        +
        public void onStartSuccess()
        Will be called after successful server start
        -
      • +
      + + + +
      • -
        -

        onAccept

        -
        public void onAccept​(CommunicationHandler ch)
        +

        onAccept

        +
        public void onAccept(CommunicationHandler ch)
        Will be called once a client has been accepted by the server
        Parameters:
        ch - the CommunicationHandler associated with the client that just connected
        -
      • +
      + + + +
      • -
        -

        onAcceptStart

        -
        public void onAcceptStart()
        +

        onAcceptStart

        +
        public void onAcceptStart()
        Will be called before the server starts to accept clients
        -
      • +
      + + + +
      • -
        -

        onAcceptEnd

        -
        public void onAcceptEnd()
        +

        onAcceptEnd

        +
        public void onAcceptEnd()
        Will be called once the server stops to accept clients
        -
      • +
      + + + +
      • -
        -

        onAcceptFailed

        -
        public void onAcceptFailed​(java.lang.Exception e)
        +

        onAcceptFailed

        +
        public void onAcceptFailed(java.lang.Exception e)
        Will be called if an error occures while trying to accept a client
        Parameters:
        e - the exception which was thrown
        -
      • +
      + + + +
      • -
        -

        onClose

        -
        public void onClose()
        +

        onClose

        +
        public void onClose()
        Will be called before the closing process of the server is beeing initiated
        -
      • +
      + + + +
      • -
        -

        onCloseEnd

        -
        public void onCloseEnd()
        +

        onCloseEnd

        +
        public void onCloseEnd()
        Will be called once the server has been closed successfully
        -
      • +
      + + + +
      • -
        -

        onCloseFailed

        -
        public void onCloseFailed​(java.lang.Exception e)
        +

        onCloseFailed

        +
        public void onCloseFailed(java.lang.Exception e)
        Will be called if an error occures while trying to close the server
        Parameters:
        e - the exception which was thrown
        -
      • +
      + + + +
      • -
        -

        onCommunicationHandlerInitFailed

        -
        public void onCommunicationHandlerInitFailed​(java.lang.Exception exception)
        +

        onCommunicationHandlerInitFailed

        +
        public void onCommunicationHandlerInitFailed(java.lang.Exception exception)
        Will be called if an error occures while trying to init the IOHandler inside the CommunicationHandler
        Parameters:
        exception - which was thrown
        -
      • +
      + + + +
      • -
        -

        onCommunicationHandlerClose

        -
        public void onCommunicationHandlerClose()
        +

        onCommunicationHandlerClose

        +
        public void onCommunicationHandlerClose()
        Will be called before a CommunicationHandler is tried to be closed
        -
      • +
      + + + +
      • -
        -

        onCommunicationHandlerCloseEnd

        -
        public void onCommunicationHandlerCloseEnd()
        +

        onCommunicationHandlerCloseEnd

        +
        public void onCommunicationHandlerCloseEnd()
        Will be called once a CommunicationHandler is closed
        -
      • +
      + + + +
      • -
        -

        onCommunicationHandlerCloseFailed

        -
        public void onCommunicationHandlerCloseFailed​(java.lang.Exception exception)
        +

        onCommunicationHandlerCloseFailed

        +
        public void onCommunicationHandlerCloseFailed(java.lang.Exception exception)
        Will be called if the closing process fails
        Parameters:
        exception - which was thrown during the process of closing the CommunicationHandler
        -
      • +
      + + + +
        +
      • +

        onSocketClosed

        +
        public void onSocketClosed(java.lang.Exception exception)
        +
        Will be fired if the ServerSocket is closed while Client tried to connect.
        +
        +
        Parameters:
        +
        exception - which is thrown during the process of client acceptance.
        +
        +
      • +
      + + + +
      • -
        -

        onSocketClosed

        -
        public void onSocketClosed​(java.lang.Exception exception)
        +

        onSocketClosed

        +
        public void onSocketClosed(java.lang.Exception exception,
        +                           java.lang.String clientAddress)
        Will be fired if the ServerSocket is closed while Client tried to connect.
        Parameters:
        exception - which is thrown during the process of client acceptance.
        +
        clientAddress - of the closed Socket
        -
      -
  • - + + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/Client.EventType.html b/doc/dev/bitbite/networking/class-use/Client.EventType.html index 832f156..90add09 100644 --- a/doc/dev/bitbite/networking/class-use/Client.EventType.html +++ b/doc/dev/bitbite/networking/class-use/Client.EventType.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.Client.EventType - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.Client.EventType

    +

    Uses of Class
    dev.bitbite.networking.Client.EventType

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/Client.html b/doc/dev/bitbite/networking/class-use/Client.html index ef6357b..42e1955 100644 --- a/doc/dev/bitbite/networking/class-use/Client.html +++ b/doc/dev/bitbite/networking/class-use/Client.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.Client - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.Client

    +

    Uses of Class
    dev.bitbite.networking.Client

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/ClientListener.html b/doc/dev/bitbite/networking/class-use/ClientListener.html index 98b1864..31afbe1 100644 --- a/doc/dev/bitbite/networking/class-use/ClientListener.html +++ b/doc/dev/bitbite/networking/class-use/ClientListener.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.ClientListener - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.ClientListener

    +

    Uses of Class
    dev.bitbite.networking.ClientListener

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/ClientManager.html b/doc/dev/bitbite/networking/class-use/ClientManager.html index ae1407a..b9460ac 100644 --- a/doc/dev/bitbite/networking/class-use/ClientManager.html +++ b/doc/dev/bitbite/networking/class-use/ClientManager.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.ClientManager - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.ClientManager

    +

    Uses of Class
    dev.bitbite.networking.ClientManager

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/CommunicationHandler.html b/doc/dev/bitbite/networking/class-use/CommunicationHandler.html index fa36217..3ed9535 100644 --- a/doc/dev/bitbite/networking/class-use/CommunicationHandler.html +++ b/doc/dev/bitbite/networking/class-use/CommunicationHandler.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.CommunicationHandler - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.CommunicationHandler

    +

    Uses of Class
    dev.bitbite.networking.CommunicationHandler

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/DataPreProcessor.TransferMode.html b/doc/dev/bitbite/networking/class-use/DataPreProcessor.TransferMode.html index 3c78dd8..dc607d2 100644 --- a/doc/dev/bitbite/networking/class-use/DataPreProcessor.TransferMode.html +++ b/doc/dev/bitbite/networking/class-use/DataPreProcessor.TransferMode.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.DataPreProcessor.TransferMode - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.DataPreProcessor.TransferMode

    +

    Uses of Class
    dev.bitbite.networking.DataPreProcessor.TransferMode

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/DataPreProcessor.html b/doc/dev/bitbite/networking/class-use/DataPreProcessor.html index 1e5cee3..07497db 100644 --- a/doc/dev/bitbite/networking/class-use/DataPreProcessor.html +++ b/doc/dev/bitbite/networking/class-use/DataPreProcessor.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.DataPreProcessor - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.DataPreProcessor

    +

    Uses of Class
    dev.bitbite.networking.DataPreProcessor

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/DataProcessingLayer.html b/doc/dev/bitbite/networking/class-use/DataProcessingLayer.html index 646709d..f425679 100644 --- a/doc/dev/bitbite/networking/class-use/DataProcessingLayer.html +++ b/doc/dev/bitbite/networking/class-use/DataProcessingLayer.html @@ -1,44 +1,38 @@ - + - + Uses of Interface dev.bitbite.networking.DataProcessingLayer - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Interface
    dev.bitbite.networking.DataProcessingLayer

    +

    Uses of Interface
    dev.bitbite.networking.DataProcessingLayer

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/IOHandler.EventType.html b/doc/dev/bitbite/networking/class-use/IOHandler.EventType.html index b722595..29c8013 100644 --- a/doc/dev/bitbite/networking/class-use/IOHandler.EventType.html +++ b/doc/dev/bitbite/networking/class-use/IOHandler.EventType.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.IOHandler.EventType - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.IOHandler.EventType

    +

    Uses of Class
    dev.bitbite.networking.IOHandler.EventType

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/IOHandler.html b/doc/dev/bitbite/networking/class-use/IOHandler.html index f07e425..42a93d2 100644 --- a/doc/dev/bitbite/networking/class-use/IOHandler.html +++ b/doc/dev/bitbite/networking/class-use/IOHandler.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.IOHandler - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.IOHandler

    +

    Uses of Class
    dev.bitbite.networking.IOHandler

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/IOHandlerListener.html b/doc/dev/bitbite/networking/class-use/IOHandlerListener.html index fe5cb3e..4e548ff 100644 --- a/doc/dev/bitbite/networking/class-use/IOHandlerListener.html +++ b/doc/dev/bitbite/networking/class-use/IOHandlerListener.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.IOHandlerListener - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.IOHandlerListener

    +

    Uses of Class
    dev.bitbite.networking.IOHandlerListener

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/SSLClient.html b/doc/dev/bitbite/networking/class-use/SSLClient.html index 9bd1e65..b05e54a 100644 --- a/doc/dev/bitbite/networking/class-use/SSLClient.html +++ b/doc/dev/bitbite/networking/class-use/SSLClient.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.SSLClient - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.SSLClient

    +

    Uses of Class
    dev.bitbite.networking.SSLClient

    No usage of dev.bitbite.networking.SSLClient
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/SSLServer.html b/doc/dev/bitbite/networking/class-use/SSLServer.html index 2329c6b..88ce1a7 100644 --- a/doc/dev/bitbite/networking/class-use/SSLServer.html +++ b/doc/dev/bitbite/networking/class-use/SSLServer.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.SSLServer - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.SSLServer

    +

    Uses of Class
    dev.bitbite.networking.SSLServer

    No usage of dev.bitbite.networking.SSLServer
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/Server.EventType.html b/doc/dev/bitbite/networking/class-use/Server.EventType.html index c7a52bc..63b00ee 100644 --- a/doc/dev/bitbite/networking/class-use/Server.EventType.html +++ b/doc/dev/bitbite/networking/class-use/Server.EventType.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.Server.EventType - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.Server.EventType

    +

    Uses of Class
    dev.bitbite.networking.Server.EventType

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/Server.html b/doc/dev/bitbite/networking/class-use/Server.html index 90e674c..e631c2c 100644 --- a/doc/dev/bitbite/networking/class-use/Server.html +++ b/doc/dev/bitbite/networking/class-use/Server.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.Server - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.Server

    +

    Uses of Class
    dev.bitbite.networking.Server

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/class-use/ServerListener.html b/doc/dev/bitbite/networking/class-use/ServerListener.html index 0e08b2e..5584587 100644 --- a/doc/dev/bitbite/networking/class-use/ServerListener.html +++ b/doc/dev/bitbite/networking/class-use/ServerListener.html @@ -1,44 +1,38 @@ - + - + Uses of Class dev.bitbite.networking.ServerListener - - - - + - - - - - - - - + + -
    - -
    -
    -

    Uses of Class
    dev.bitbite.networking.ServerListener

    +

    Uses of Class
    dev.bitbite.networking.ServerListener

    -
    -
    + +
    -
    - diff --git a/doc/dev/bitbite/networking/package-frame.html b/doc/dev/bitbite/networking/package-frame.html new file mode 100644 index 0000000..5a68824 --- /dev/null +++ b/doc/dev/bitbite/networking/package-frame.html @@ -0,0 +1,41 @@ + + + + + +dev.bitbite.networking + + + + + +

    dev.bitbite.networking

    +
    +

    Interfaces

    + +

    Classes

    + +

    Enums

    + +
    + + diff --git a/doc/dev/bitbite/networking/package-summary.html b/doc/dev/bitbite/networking/package-summary.html index ddb2272..113e1f7 100644 --- a/doc/dev/bitbite/networking/package-summary.html +++ b/doc/dev/bitbite/networking/package-summary.html @@ -1,43 +1,37 @@ - + - + dev.bitbite.networking - - - - + - - - - - - - - + + -
    - -
    -

    Package dev.bitbite.networking

    -
    -
    -
    - diff --git a/doc/dev/bitbite/networking/package-tree.html b/doc/dev/bitbite/networking/package-tree.html index 74b32bb..b6e7918 100644 --- a/doc/dev/bitbite/networking/package-tree.html +++ b/doc/dev/bitbite/networking/package-tree.html @@ -1,43 +1,37 @@ - + - + dev.bitbite.networking Class Hierarchy - - - - + - - - - - - - - + + -
    - -
    -

    Hierarchy For Package dev.bitbite.networking

    -

    Class Hierarchy

    -
    -

    Interface Hierarchy

    -
    -

    Enum Hierarchy

    -
    -
    - diff --git a/doc/dev/bitbite/networking/package-use.html b/doc/dev/bitbite/networking/package-use.html index 346bb47..bf8a083 100644 --- a/doc/dev/bitbite/networking/package-use.html +++ b/doc/dev/bitbite/networking/package-use.html @@ -1,43 +1,37 @@ - + - + Uses of Package dev.bitbite.networking - - - - + - - - - - - - - + + -
    - -
    -

    Uses of Package
    dev.bitbite.networking

    -
    -
    -
    - diff --git a/doc/help-doc.html b/doc/help-doc.html index 4e853bb..1b156cf 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -1,39 +1,33 @@ - + - + API Help - - - - + - - - - - - - - + + -
    - -
    -

    How This API Document Is Organized

    This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
    @@ -72,132 +75,110 @@

    How This API Document Is Organized

    • -

      Package

      -

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

        -
      • Interfaces
      • +
      • Interfaces (italic)
      • Classes
      • Enums
      • Exceptions
      • Errors
      • Annotation Types
      -
    • -
      -

      Class or Interface

      +

      Class/Interface

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

        -
      • Class Inheritance Diagram
      • +
      • Class inheritance diagram
      • Direct Subclasses
      • All Known Subinterfaces
      • All Known Implementing Classes
      • -
      • Class or Interface Declaration
      • -
      • Class or Interface Description
      • +
      • Class/interface declaration
      • +
      • Class/interface description
      -
      • Nested Class Summary
      • Field Summary
      • -
      • Property Summary
      • Constructor Summary
      • Method Summary
      -
        -
      • Field Details
      • -
      • Property Details
      • -
      • Constructor Details
      • -
      • Method Details
      • +
      • Field Detail
      • +
      • Constructor Detail
      • +
      • Method Detail

      Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

      -
    • -

      Annotation Type

      Each annotation type has its own separate page with the following sections:

        -
      • Annotation Type Declaration
      • -
      • Annotation Type Description
      • +
      • Annotation Type declaration
      • +
      • Annotation Type description
      • Required Element Summary
      • Optional Element Summary
      • -
      • Element Details
      • +
      • Element Detail
      -
    • -

      Enum

      Each enum has its own separate page with the following sections:

        -
      • Enum Declaration
      • -
      • Enum Description
      • +
      • Enum declaration
      • +
      • Enum description
      • Enum Constant Summary
      • -
      • Enum Constant Details
      • +
      • Enum Constant Detail
      -
    • -

      Use

      -

      Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its "Use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

      -
      +

      Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

    • -

      Tree (Class Hierarchy)

      -

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

      +

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

      • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • -
      • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
      • +
      • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      -
    • -

      Deprecated API

      The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

      -
    • -

      Index

      -

      The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

      -
      +

      The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

      +
    • +
    • +

      Prev/Next

      +

      These links take you to the next or previous class, interface, package, or related page.

      +
    • +
    • +

      Frames/No Frames

      +

      These links show and hide the HTML frames. All pages are available with or without frames.

      +
    • +
    • +

      All Classes

      +

      The All Classes link shows all classes and interfaces except non-static nested types.

    • -

      Serialized Form

      Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

      -
    • -

      Constant Field Values

      The Constant Field Values page lists the static final fields and their values.

      -
      -
    • -
    • -
      -

      Search

      -

      You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

      -
    -
    -This help file applies to API documentation generated by the standard doclet.
    -
    - diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html index c35c994..ddbc8c9 100644 --- a/doc/index-files/index-1.html +++ b/doc/index-files/index-1.html @@ -1,39 +1,33 @@ - + - + A-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    A

    -
    ACCEPT - dev.bitbite.networking.Server.EventType
    -
     
    -
    ACCEPT_END - dev.bitbite.networking.Server.EventType
    -
     
    -
    ACCEPT_FAILED - dev.bitbite.networking.Server.EventType
    -
     
    -
    ACCEPT_START - dev.bitbite.networking.Server.EventType
    -
     
    -
    addLayer(DataPreProcessor.TransferMode, int, DataProcessingLayer) - Method in class dev.bitbite.networking.DataPreProcessor
    +
    addLayer(DataPreProcessor.TransferMode, DataProcessingLayer) - Method in class dev.bitbite.networking.DataPreProcessor
    -
    Inserts a layer at the specified index.
    +
    Appends a layer at the end of the list
    -
    addLayer(DataPreProcessor.TransferMode, DataProcessingLayer) - Method in class dev.bitbite.networking.DataPreProcessor
    +
    addLayer(DataPreProcessor.TransferMode, int, DataProcessingLayer) - Method in class dev.bitbite.networking.DataPreProcessor
    -
    Appends a layer at the end of the list
    +
    Inserts a layer at the specified index.
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html index ad7ee09..68cf73e 100644 --- a/doc/index-files/index-10.html +++ b/doc/index-files/index-10.html @@ -1,39 +1,33 @@ - + - + L-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    L

    @@ -80,16 +80,13 @@

    L

    listeners - Variable in class dev.bitbite.networking.Server
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html index 5b05795..726a184 100644 --- a/doc/index-files/index-11.html +++ b/doc/index-files/index-11.html @@ -1,39 +1,33 @@ - + - + N-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    N

    -
    notifyListeners(Client.EventType, Object...) - Method in class dev.bitbite.networking.Client
    +
    notifyListeners(Client.EventType, Object...) - Method in class dev.bitbite.networking.Client
    -
    Calls the respective function of each listener depending on the event type.
    - Optionally propagates additional info such as exceptions.
    +
    Calls the respective function of each listener depending on the event type.
    -
    notifyListeners(IOHandler.EventType, Object...) - Method in class dev.bitbite.networking.IOHandler
    +
    notifyListeners(IOHandler.EventType, Object...) - Method in class dev.bitbite.networking.IOHandler
    -
    Calls the respective function of each listener depending on the event type.
    - Optionally Propagates additional info such as exceptions.
    +
    Calls the respective function of each listener depending on the event type.
    -
    notifyListeners(Server.EventType, Object...) - Method in class dev.bitbite.networking.Server
    +
    notifyListeners(Server.EventType, Object...) - Method in class dev.bitbite.networking.Server
    -
    Calls the respective function of each listener depending on the event type.
    - Optionally Propagates additional info such as exceptions.
    +
    Calls the respective function of each listener depending on the event type.
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html index 914ae51..f24207e 100644 --- a/doc/index-files/index-12.html +++ b/doc/index-files/index-12.html @@ -1,39 +1,33 @@ - + - + O-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    O

    -
    onAccept(CommunicationHandler) - Method in class dev.bitbite.networking.ServerListener
    +
    onAccept(CommunicationHandler) - Method in class dev.bitbite.networking.ServerListener
    Will be called once a client has been accepted by the server
    -
    onAcceptEnd() - Method in class dev.bitbite.networking.ServerListener
    +
    onAcceptEnd() - Method in class dev.bitbite.networking.ServerListener
    Will be called once the server stops to accept clients
    -
    onAcceptFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    +
    onAcceptFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    Will be called if an error occures while trying to accept a client
    -
    onAcceptStart() - Method in class dev.bitbite.networking.ServerListener
    +
    onAcceptStart() - Method in class dev.bitbite.networking.ServerListener
    Will be called before the server starts to accept clients
    -
    onClose() - Method in class dev.bitbite.networking.ServerListener
    +
    onClose() - Method in class dev.bitbite.networking.ServerListener
    Will be called before the closing process of the server is beeing initiated
    -
    onCloseEnd() - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onCloseEnd() - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called once the streams have been closed
    -
    onCloseEnd() - Method in class dev.bitbite.networking.ServerListener
    +
    onCloseEnd() - Method in class dev.bitbite.networking.ServerListener
    Will be called once the server has been closed successfully
    -
    onCloseFailed(Exception) - Method in class dev.bitbite.networking.ClientListener
    +
    onCloseFailed(Exception) - Method in class dev.bitbite.networking.ClientListener
    Will be called if the disconnection and closing process failed
    -
    onCloseFailed(Exception) - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onCloseFailed(Exception) - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called if an error occurs while trying to close the streams
    -
    onCloseFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    +
    onCloseFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    Will be called if an error occures while trying to close the server
    -
    onCloseRequested() - Method in class dev.bitbite.networking.ClientListener
    +
    onCloseRequested() - Method in class dev.bitbite.networking.ClientListener
    Will be called before the disconnection and closing processes being initiated
    -
    onCloseStart() - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onCloseStart() - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called before the closing of the streams is started
    -
    onCloseSuccess() - Method in class dev.bitbite.networking.ClientListener
    +
    onCloseSuccess() - Method in class dev.bitbite.networking.ClientListener
    Will be called after finishing the disconnection process
    -
    onCommunicationHandlerClose() - Method in class dev.bitbite.networking.ServerListener
    +
    onCommunicationHandlerClose() - Method in class dev.bitbite.networking.ServerListener
    Will be called before a CommunicationHandler is tried to be closed
    -
    onCommunicationHandlerCloseEnd() - Method in class dev.bitbite.networking.ServerListener
    +
    onCommunicationHandlerCloseEnd() - Method in class dev.bitbite.networking.ServerListener
    Will be called once a CommunicationHandler is closed
    -
    onCommunicationHandlerCloseFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    +
    onCommunicationHandlerCloseFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    Will be called if the closing process fails
    -
    onCommunicationHandlerInitFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    +
    onCommunicationHandlerInitFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    Will be called if an error occures while trying to init the IOHandler inside the CommunicationHandler
    -
    onConnectionCreation() - Method in class dev.bitbite.networking.ClientListener
    +
    onConnectionCreation() - Method in class dev.bitbite.networking.ClientListener
    Will be called before the Client tries to connect to the server
    -
    onConnectionFailed(Exception) - Method in class dev.bitbite.networking.ClientListener
    +
    onConnectionFailed(Exception) - Method in class dev.bitbite.networking.ClientListener
    Will be called if an error occured while trying to connect to the server
    -
    onConnectionSuccess() - Method in class dev.bitbite.networking.ClientListener
    +
    onConnectionSuccess() - Method in class dev.bitbite.networking.ClientListener
    Will be called if the connection to the server was successful
    -
    onDataReadEnd() - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onDataReadEnd() - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called once the process of reading data from the inputStream ends
    -
    onDataReadFailed(Exception) - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onDataReadFailed(Exception) - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called if an error occurs while trying to read data from the inputStream
    -
    onDataReadStart() - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onDataReadStart() - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called before the process of reading data from the inputStream is being started
    -
    onDisable() - Method in interface dev.bitbite.networking.DataProcessingLayer
    +
    onDisable() - Method in interface dev.bitbite.networking.DataProcessingLayer
    +
    +
    Gets called on Server.close() to disable the DataProcessingLayer.
    +
    +
    onEnable() - Method in interface dev.bitbite.networking.DataProcessingLayer
    -
    Gets called on Server.close() to disable the DataProcessingLayer.
    +
    Gets called on Server.start() to initialize the DataProcessingLayer.
    -
    onEnable() - Method in interface dev.bitbite.networking.DataProcessingLayer
    +
    onSocketClosed(Exception) - Method in class dev.bitbite.networking.ServerListener
    -
    Gets called on Server.start() to initialize the DataProcessingLayer.
    +
    Will be fired if the ServerSocket is closed while Client tried to connect.
    -
    onSocketClosed(Exception) - Method in class dev.bitbite.networking.ServerListener
    +
    onSocketClosed(Exception, String) - Method in class dev.bitbite.networking.ServerListener
    Will be fired if the ServerSocket is closed while Client tried to connect.
    -
    onStart() - Method in class dev.bitbite.networking.ServerListener
    +
    onStart() - Method in class dev.bitbite.networking.ServerListener
    Will be called before server startup
    -
    onStartFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    +
    onStartFailed(Exception) - Method in class dev.bitbite.networking.ServerListener
    Will be called if server start failed
    -
    onStartSuccess() - Method in class dev.bitbite.networking.ServerListener
    +
    onStartSuccess() - Method in class dev.bitbite.networking.ServerListener
    Will be called after successful server start
    -
    onWrite(String) - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onWrite(String) - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called before data is sent over the outputStream
    -
    onWriteEnd() - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onWriteEnd() - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called after the writing to the outputStream has been finished
    -
    onWriteFailed(Exception) - Method in class dev.bitbite.networking.IOHandlerListener
    +
    onWriteFailed(Exception) - Method in class dev.bitbite.networking.IOHandlerListener
    Will be called if the writing the data to the outputStream fails
    -
    openServerSocket() - Method in class dev.bitbite.networking.Server
    +
    openServerSocket() - Method in class dev.bitbite.networking.Server
    Opens the ServerSocket.
    -
    openServerSocket() - Method in class dev.bitbite.networking.SSLServer
    +
    openServerSocket() - Method in class dev.bitbite.networking.SSLServer
     
    -
    openSocket() - Method in class dev.bitbite.networking.Client
    +
    openSocket() - Method in class dev.bitbite.networking.Client
    Opens the Socket connection.
    -
    openSocket() - Method in class dev.bitbite.networking.SSLClient
    -
     
    -
    OUT - dev.bitbite.networking.DataPreProcessor.TransferMode
    +
    openSocket() - Method in class dev.bitbite.networking.SSLClient
     
    outgoingDataProcessingLayers - Variable in class dev.bitbite.networking.DataPreProcessor
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html index e4ec484..3e4a8cd 100644 --- a/doc/index-files/index-13.html +++ b/doc/index-files/index-13.html @@ -1,39 +1,33 @@ - + - + P-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    P

    @@ -77,43 +77,40 @@

    P

     
    PORT - Variable in class dev.bitbite.networking.Server
     
    -
    process(DataPreProcessor.TransferMode, String) - Method in class dev.bitbite.networking.DataPreProcessor
    +
    process(DataPreProcessor.TransferMode, String) - Method in class dev.bitbite.networking.DataPreProcessor
    Sends the data to each registered DataProcessingLayer If no DataProcessingLayer is registered, data will stay as it is and returns the processed data
    -
    process(String) - Method in interface dev.bitbite.networking.DataProcessingLayer
    +
    process(String) - Method in interface dev.bitbite.networking.DataProcessingLayer
    Processes incoming data
    -
    processReceivedData(String) - Method in class dev.bitbite.networking.Client
    +
    processReceivedData(String) - Method in class dev.bitbite.networking.Client
    This function will be called once the client receives data from the server.
    -
    processReceivedData(String) - Method in class dev.bitbite.networking.CommunicationHandler
    +
    processReceivedData(String) - Method in class dev.bitbite.networking.CommunicationHandler
    Gets called by the IOHandler when data is received from the client.
    -
    processReceivedData(String) - Method in class dev.bitbite.networking.SSLClient
    -
     
    -
    processReceivedData(String, String) - Method in class dev.bitbite.networking.Server
    +
    processReceivedData(String, String) - Method in class dev.bitbite.networking.Server
    This function will be called once the server receives data from the client.
    -
    processReceivedData(String, String) - Method in class dev.bitbite.networking.SSLServer
    +
    processReceivedData(String) - Method in class dev.bitbite.networking.SSLClient
    +
     
    +
    processReceivedData(String, String) - Method in class dev.bitbite.networking.SSLServer
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html index 0a3f8e8..a656e2b 100644 --- a/doc/index-files/index-14.html +++ b/doc/index-files/index-14.html @@ -1,39 +1,33 @@ - + - + R-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    R

    reader - Variable in class dev.bitbite.networking.IOHandler
     
    -
    registerListener(ClientListener) - Method in class dev.bitbite.networking.Client
    +
    registerListener(ClientListener) - Method in class dev.bitbite.networking.Client
    Registers a ClientListener
    -
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.Client
    +
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.Client
    Registers a IOHandlerListener
    -
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.CommunicationHandler
    +
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.CommunicationHandler
    Registers a listener to the underlying IOHandler
    -
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.IOHandler
    +
    registerListener(ArrayList<IOHandlerListener>) - Method in class dev.bitbite.networking.CommunicationHandler
    -
    Registers a ClientListener
    +
    Registers a list of listeners to the underlying IOHandler
    -
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.Server
    +
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.IOHandler
    -
    Registers an IOHandlerListener
    +
    Registers a ClientListener
    -
    registerListener(ServerListener) - Method in class dev.bitbite.networking.Server
    +
    registerListener(ServerListener) - Method in class dev.bitbite.networking.Server
    Registers a ClientListener
    -
    registerListener(ArrayList<IOHandlerListener>) - Method in class dev.bitbite.networking.CommunicationHandler
    +
    registerListener(IOHandlerListener) - Method in class dev.bitbite.networking.Server
    -
    Registers a list of listeners to the underlying IOHandler
    +
    Registers an IOHandlerListener
    -
    removeLayer(DataPreProcessor.TransferMode, DataProcessingLayer) - Method in class dev.bitbite.networking.DataPreProcessor
    +
    removeLayer(DataPreProcessor.TransferMode, DataProcessingLayer) - Method in class dev.bitbite.networking.DataPreProcessor
    Removes a layer from the list
    -
    removeListener(ClientListener) - Method in class dev.bitbite.networking.Client
    +
    removeListener(ClientListener) - Method in class dev.bitbite.networking.Client
    Removes ClientListener from the listeners
    -
    removeListener(IOHandlerListener) - Method in class dev.bitbite.networking.Client
    +
    removeListener(IOHandlerListener) - Method in class dev.bitbite.networking.Client
    Removes IOHandlerListener from the listeners
    -
    removeListener(IOHandlerListener) - Method in class dev.bitbite.networking.IOHandler
    +
    removeListener(IOHandlerListener) - Method in class dev.bitbite.networking.IOHandler
    Removes ClientListener from the listeners
    -
    removeListener(IOHandlerListener) - Method in class dev.bitbite.networking.Server
    +
    removeListener(ServerListener) - Method in class dev.bitbite.networking.Server
    -
    Removes IOHandlerListener from the listeners
    +
    Removes ClientListener from the listeners
    -
    removeListener(ServerListener) - Method in class dev.bitbite.networking.Server
    +
    removeListener(IOHandlerListener) - Method in class dev.bitbite.networking.Server
    -
    Removes ClientListener from the listeners
    +
    Removes IOHandlerListener from the listeners
    -
    run() - Method in class dev.bitbite.networking.ClientManager
    +
    run() - Method in class dev.bitbite.networking.ClientManager
    Starts the process of accepting clients to the server.
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html index 51d616c..748ad93 100644 --- a/doc/index-files/index-15.html +++ b/doc/index-files/index-15.html @@ -1,39 +1,33 @@ - + - + S-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    S

    -
    send(String) - Method in class dev.bitbite.networking.Client
    +
    send(String) - Method in class dev.bitbite.networking.Client
    Sends data to the Server
    -
    send(String) - Method in class dev.bitbite.networking.CommunicationHandler
    +
    send(String) - Method in class dev.bitbite.networking.CommunicationHandler
    Sends data to the client
    -
    send(String, String) - Method in class dev.bitbite.networking.Server
    +
    send(String, String) - Method in class dev.bitbite.networking.Server
     
    server - Variable in class dev.bitbite.networking.ClientManager
     
    Server - Class in dev.bitbite.networking
    -
    Represents an abstract implementation of the server-side connection.
    - The server must be started using Server.start() - for clients to be able to connect.
    +
    Represents an abstract implementation of the server-side connection.
    -
    Server(int) - Constructor for class dev.bitbite.networking.Server
    +
    Server(int) - Constructor for class dev.bitbite.networking.Server
    Creates a server object and sets the port the server will try to listen on
    @@ -104,47 +102,36 @@

    S

    This class contains all functions which, if registered at the server object, will be called when certain events are happening.
    -
    ServerListener() - Constructor for class dev.bitbite.networking.ServerListener
    +
    ServerListener() - Constructor for class dev.bitbite.networking.ServerListener
     
    serverSocket - Variable in class dev.bitbite.networking.Server
     
    -
    shutdown() - Method in class dev.bitbite.networking.DataPreProcessor
    +
    shutdown() - Method in class dev.bitbite.networking.DataPreProcessor
    Deactivates the DataProcessingLayers
    socket - Variable in class dev.bitbite.networking.Client
     
    -
    SOCKET_CLOSED - dev.bitbite.networking.Server.EventType
    -
     
    SSLClient - Class in dev.bitbite.networking
     
    -
    SSLClient(String, int) - Constructor for class dev.bitbite.networking.SSLClient
    +
    SSLClient(String, int) - Constructor for class dev.bitbite.networking.SSLClient
     
    SSLServer - Class in dev.bitbite.networking
     
    -
    SSLServer(int) - Constructor for class dev.bitbite.networking.SSLServer
    +
    SSLServer(int) - Constructor for class dev.bitbite.networking.SSLServer
     
    -
    start() - Method in class dev.bitbite.networking.Server
    +
    start() - Method in class dev.bitbite.networking.Server
    Opens a ServerSocket, initializes the DataProcessingLayers and starts listening on the specified port
    -
    START - dev.bitbite.networking.Server.EventType
    -
     
    -
    START_FAILED - dev.bitbite.networking.Server.EventType
    -
     
    -
    START_SUCCESS - dev.bitbite.networking.Server.EventType
    -
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html index 2469cf1..d2d1bb3 100644 --- a/doc/index-files/index-16.html +++ b/doc/index-files/index-16.html @@ -1,39 +1,33 @@ - + - + T-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    T

    -
    TransferMode() - Constructor for enum dev.bitbite.networking.DataPreProcessor.TransferMode
    +
    TransferMode() - Constructor for enum dev.bitbite.networking.DataPreProcessor.TransferMode
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html index 23fd2d1..885f143 100644 --- a/doc/index-files/index-17.html +++ b/doc/index-files/index-17.html @@ -1,39 +1,33 @@ - + - + V-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    V

    -
    valueOf(String) - Static method in enum dev.bitbite.networking.Client.EventType
    +
    valueOf(String) - Static method in enum dev.bitbite.networking.Client.EventType
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum dev.bitbite.networking.DataPreProcessor.TransferMode
    +
    valueOf(String) - Static method in enum dev.bitbite.networking.DataPreProcessor.TransferMode
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum dev.bitbite.networking.IOHandler.EventType
    +
    valueOf(String) - Static method in enum dev.bitbite.networking.IOHandler.EventType
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum dev.bitbite.networking.Server.EventType
    +
    valueOf(String) - Static method in enum dev.bitbite.networking.Server.EventType
    Returns the enum constant of this type with the specified name.
    -
    values() - Static method in enum dev.bitbite.networking.Client.EventType
    +
    values() - Static method in enum dev.bitbite.networking.Client.EventType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum dev.bitbite.networking.DataPreProcessor.TransferMode
    +
    values() - Static method in enum dev.bitbite.networking.DataPreProcessor.TransferMode
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum dev.bitbite.networking.IOHandler.EventType
    +
    values() - Static method in enum dev.bitbite.networking.IOHandler.EventType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum dev.bitbite.networking.Server.EventType
    +
    values() - Static method in enum dev.bitbite.networking.Server.EventType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html index f152b19..ead2f75 100644 --- a/doc/index-files/index-18.html +++ b/doc/index-files/index-18.html @@ -1,39 +1,33 @@ - + - + W-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    W

    -
    write(String) - Method in class dev.bitbite.networking.IOHandler
    +
    write(String) - Method in class dev.bitbite.networking.IOHandler
    Writes data to the OutputStream and flushes it.
    -
    WRITE - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    WRITE_END - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    WRITE_FAILED - dev.bitbite.networking.IOHandler.EventType
    -
     
    writer - Variable in class dev.bitbite.networking.IOHandler
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html index ba64e3c..8afb584 100644 --- a/doc/index-files/index-2.html +++ b/doc/index-files/index-2.html @@ -1,39 +1,33 @@ - + - + B-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    B

    -
    broadcast(String) - Method in class dev.bitbite.networking.Server
    +
    broadcast(String) - Method in class dev.bitbite.networking.Server
    Sends the data to all connected clients.
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html index f975105..bed963d 100644 --- a/doc/index-files/index-3.html +++ b/doc/index-files/index-3.html @@ -1,39 +1,33 @@ - + - + C-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    C

    Client - Class in dev.bitbite.networking
    -
    Represents an abstract implementation of the client-side connection.
    - The connection process can be initiated using the client objects Client.connect() method, - which will return true, if the connection process has been successful.
    - Closing the connection can be done using the client objects Client.close() method, - which will return true, if the disconnection process has been completed successfully.
    - Incoming data from the server will be forwarded to Client.processReceivedData(String).
    - Data to the server can be sent using the clients IOHandler.
    - Some events trigger the notification of registered ClientListeners.
    +
    Represents an abstract implementation of the client-side connection.
    -
    Client(String, int) - Constructor for class dev.bitbite.networking.Client
    +
    Client(String, int) - Constructor for class dev.bitbite.networking.Client
    Creates a Client object and sets the endpoint on which on startup the client will try to connect to
    -
    Client(URL) - Constructor for class dev.bitbite.networking.Client
    +
    Client(URL) - Constructor for class dev.bitbite.networking.Client
    Creates a Client object and sets the endpoint to which the client will connect on startup.
    @@ -102,103 +95,64 @@

    C

    This class contains all functions which, if registered at the client object, will be called when certain events are happening.
    -
    ClientListener() - Constructor for class dev.bitbite.networking.ClientListener
    -
     
    -
    clientManager - Variable in class dev.bitbite.networking.CommunicationHandler
    -
     
    -
    clientManager - Variable in class dev.bitbite.networking.Server
    +
    ClientListener() - Constructor for class dev.bitbite.networking.ClientListener
     
    ClientManager - Class in dev.bitbite.networking
    Administrates the clients an runs in its own Thread.
    -
    ClientManager(Server) - Constructor for class dev.bitbite.networking.ClientManager
    +
    ClientManager(Server) - Constructor for class dev.bitbite.networking.ClientManager
    Initiates a ClientManager object
    +
    clientManager - Variable in class dev.bitbite.networking.CommunicationHandler
    +
     
    +
    clientManager - Variable in class dev.bitbite.networking.Server
    +
     
    clientSocket - Variable in class dev.bitbite.networking.CommunicationHandler
     
    -
    close() - Method in class dev.bitbite.networking.Client
    +
    close() - Method in class dev.bitbite.networking.Client
    -
    Closes the connection.
    - Listeners will be called before the disconnection process is started - and when it succeeded or failed.
    - It will also call the close method of the client objects IOHandler
    +
    Closes the connection.
    -
    close() - Method in class dev.bitbite.networking.ClientManager
    +
    close() - Method in class dev.bitbite.networking.ClientManager
    Closes all client connection and the serversocket itself
    -
    close() - Method in class dev.bitbite.networking.CommunicationHandler
    +
    close() - Method in class dev.bitbite.networking.CommunicationHandler
    Closes the IOStreams and the socket itself.
    -
    close() - Method in class dev.bitbite.networking.IOHandler
    +
    close() - Method in class dev.bitbite.networking.IOHandler
    Closes the streams
    -
    close() - Method in class dev.bitbite.networking.Server
    +
    close() - Method in class dev.bitbite.networking.Server
    Initiates the closing process of the Server with closing the ClientManager and disabling the DataProcessingLayers
    -
    CLOSE - dev.bitbite.networking.Client.EventType
    -
     
    -
    CLOSE - dev.bitbite.networking.Server.EventType
    -
     
    -
    CLOSE_END - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    CLOSE_END - dev.bitbite.networking.Server.EventType
    -
     
    -
    CLOSE_FAILED - dev.bitbite.networking.Client.EventType
    -
     
    -
    CLOSE_FAILED - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    CLOSE_FAILED - dev.bitbite.networking.Server.EventType
    -
     
    -
    CLOSE_START - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    CLOSE_SUCCESS - dev.bitbite.networking.Client.EventType
    -
     
    communicationHandler - Variable in class dev.bitbite.networking.ClientManager
     
    CommunicationHandler - Class in dev.bitbite.networking
    Manages the Communication with a client by handling its IO.
    -
    CommunicationHandler(Socket, ClientManager) - Constructor for class dev.bitbite.networking.CommunicationHandler
    +
    CommunicationHandler(Socket, ClientManager) - Constructor for class dev.bitbite.networking.CommunicationHandler
    Creates a CommunicationHandler object for a socket
    -
    COMMUNICATIONHANDLER_CLOSE - dev.bitbite.networking.Server.EventType
    -
     
    -
    COMMUNICATIONHANDLER_CLOSE_END - dev.bitbite.networking.Server.EventType
    -
     
    -
    COMMUNICATIONHANDLER_CLOSE_FAILED - dev.bitbite.networking.Server.EventType
    -
     
    -
    COMMUNICATIONHANDLER_INIT_FAILED - dev.bitbite.networking.Server.EventType
    -
     
    -
    connect() - Method in class dev.bitbite.networking.Client
    +
    connect() - Method in class dev.bitbite.networking.Client
    -
    Initiates the connection process.
    - The IOHandler will be created.
    +
    Initiates the connection process.
    -
    CONNECTION - dev.bitbite.networking.Client.EventType
    -
     
    -
    CONNECTION_FAILED - dev.bitbite.networking.Client.EventType
    -
     
    -
    CONNECTION_SUCCESS - dev.bitbite.networking.Client.EventType
    -
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html index bbc38f1..d2cac29 100644 --- a/doc/index-files/index-4.html +++ b/doc/index-files/index-4.html @@ -1,39 +1,33 @@ - + - + D-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    D

    -
    DATA_READ_END - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    DATA_READ_FAILED - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    DATA_READ_START - dev.bitbite.networking.IOHandler.EventType
    -
     
    -
    dataPreProcessor - Variable in class dev.bitbite.networking.Server
    -
     
    DataPreProcessor - Class in dev.bitbite.networking
    Keeps track of all DataProcessingLayers and processes data by passing it to each layer and returning its result.
    -
    DataPreProcessor() - Constructor for class dev.bitbite.networking.DataPreProcessor
    +
    DataPreProcessor() - Constructor for class dev.bitbite.networking.DataPreProcessor
    Instantiates the DataPreProcessor
    +
    dataPreProcessor - Variable in class dev.bitbite.networking.Server
    +
     
    DataPreProcessor.TransferMode - Enum in dev.bitbite.networking
    The Transfer directions data can travel
    @@ -101,16 +95,13 @@

    D

    dev.bitbite.networking - package dev.bitbite.networking
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html index 155e643..32fbeef 100644 --- a/doc/index-files/index-5.html +++ b/doc/index-files/index-5.html @@ -1,39 +1,33 @@ - + - + E-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    E

    -
    EventType() - Constructor for enum dev.bitbite.networking.Client.EventType
    +
    EventType() - Constructor for enum dev.bitbite.networking.Client.EventType
     
    -
    EventType() - Constructor for enum dev.bitbite.networking.IOHandler.EventType
    +
    EventType() - Constructor for enum dev.bitbite.networking.IOHandler.EventType
     
    -
    EventType() - Constructor for enum dev.bitbite.networking.Server.EventType
    +
    EventType() - Constructor for enum dev.bitbite.networking.Server.EventType
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html index 6b480b6..ba839b5 100644 --- a/doc/index-files/index-6.html +++ b/doc/index-files/index-6.html @@ -1,39 +1,33 @@ - + - + G-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    G

    -
    getCommunicationHandler() - Method in class dev.bitbite.networking.ClientManager
    +
    getCommunicationHandler() - Method in class dev.bitbite.networking.ClientManager
    Returns a list of CommunicationHandlers
    -
    getCommunicationHandlerByIP(String) - Method in class dev.bitbite.networking.ClientManager
    +
    getCommunicationHandlerByIP(String) - Method in class dev.bitbite.networking.ClientManager
    Searches for a CommunicationHandler by its sockets remote socket address and returns it.
    -
    getDataPreProcessor() - Method in class dev.bitbite.networking.Server
    +
    getDataPreProcessor() - Method in class dev.bitbite.networking.Server
    Returns the DataPreProcessor of this server object.
    -
    getIOHandler() - Method in class dev.bitbite.networking.Client
    +
    getIOHandler() - Method in class dev.bitbite.networking.Client
    Returns the IOHandler associated with the client object
    -
    getIOHandlerListeners() - Method in class dev.bitbite.networking.Server
    +
    getIOHandlerListeners() - Method in class dev.bitbite.networking.Server
    Returns a list of all IOHandlers registered at the server
    -
    getIP() - Method in class dev.bitbite.networking.CommunicationHandler
    +
    getIP() - Method in class dev.bitbite.networking.CommunicationHandler
     
    -
    getLayerAt(DataPreProcessor.TransferMode, int) - Method in class dev.bitbite.networking.DataPreProcessor
    +
    getLayerAt(DataPreProcessor.TransferMode, int) - Method in class dev.bitbite.networking.DataPreProcessor
    Returns a layer of the specified transfermode at a specified position in the list.
    -
    getLayers(DataPreProcessor.TransferMode) - Method in class dev.bitbite.networking.DataPreProcessor
    +
    getLayers(DataPreProcessor.TransferMode) - Method in class dev.bitbite.networking.DataPreProcessor
    Returns the list of layers
    -
    getServer() - Method in class dev.bitbite.networking.ClientManager
    +
    getServer() - Method in class dev.bitbite.networking.ClientManager
    Returns the server object related to this clientmanager
    -
    getServerListeners() - Method in class dev.bitbite.networking.Server
    +
    getServerListeners() - Method in class dev.bitbite.networking.Server
    Returns a list of all ServerListeners registered at the server
    -
    getServerSocket() - Method in class dev.bitbite.networking.Server
    +
    getServerSocket() - Method in class dev.bitbite.networking.Server
    Returns the current ServerSocket
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html index 1b5f905..5593516 100644 --- a/doc/index-files/index-7.html +++ b/doc/index-files/index-7.html @@ -1,39 +1,33 @@ - + - + H-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    H

    @@ -76,16 +76,13 @@

    H

    HOST - Variable in class dev.bitbite.networking.Client
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html index b2d9038..2cc0414 100644 --- a/doc/index-files/index-8.html +++ b/doc/index-files/index-8.html @@ -1,39 +1,33 @@ - + - + I-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    I

    -
    IN - dev.bitbite.networking.DataPreProcessor.TransferMode
    -
     
    incomingDataProcessingLayers - Variable in class dev.bitbite.networking.DataPreProcessor
     
    -
    initLayers() - Method in class dev.bitbite.networking.DataPreProcessor
    +
    initLayers() - Method in class dev.bitbite.networking.DataPreProcessor
    Initializes the DataProcessingLayers
    @@ -91,10 +89,9 @@

    I

    This IOHandler class combines an input- and an output stream object into a single class.
    -
    IOHandler(InputStream, OutputStream, Consumer<String>) - Constructor for class dev.bitbite.networking.IOHandler
    +
    IOHandler(InputStream, OutputStream, Consumer<String>) - Constructor for class dev.bitbite.networking.IOHandler
    -
    Initializes the IOHandler with the given Streams and read-Callback method.
    - It also starts a Thread which listens for incoming data from the inputStream.
    +
    Initializes the IOHandler with the given Streams and read-Callback method.
    IOHandler.EventType - Enum in dev.bitbite.networking
    @@ -105,27 +102,24 @@

    I

    This class contains all functions which, if registered at the IOHandler object, will be called when certain events are happening.
    -
    IOHandlerListener() - Constructor for class dev.bitbite.networking.IOHandlerListener
    +
    IOHandlerListener() - Constructor for class dev.bitbite.networking.IOHandlerListener
     
    ioListeners - Variable in class dev.bitbite.networking.Client
     
    ioListeners - Variable in class dev.bitbite.networking.Server
     
    -
    isConnected() - Method in class dev.bitbite.networking.Client
    +
    isConnected() - Method in class dev.bitbite.networking.Client
    Indicates whether the current client object has an active connection to the server
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html index 208b7d1..e4d5237 100644 --- a/doc/index-files/index-9.html +++ b/doc/index-files/index-9.html @@ -1,39 +1,33 @@ - + - + K-Index - - - - + - - - - - - - - + + -
    - -
    -
    -
    -

    Index

    -
    A B C D E G H I K L N O P R S T V W 
    All Classes All Packages + + +
    + +
    A B C D E G H I K L N O P R S T V W 

    K

    @@ -76,16 +76,13 @@

    K

    keepAlive - Variable in class dev.bitbite.networking.Client
     
    -A B C D E G H I K L N O P R S T V W 
    All Classes All Packages
    -
    - diff --git a/doc/index.html b/doc/index.html index f088796..ff87318 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,26 +1,72 @@ - + - + Generated Documentation (Untitled) - - - - - - - - + - -
    + + + + <noscript> -<p>JavaScript is disabled on your browser.</p> +<div>JavaScript is disabled on your browser.</div> </noscript> -<p><a href="dev/bitbite/networking/package-summary.html">dev/bitbite/networking/package-summary.html</a></p> -</main> -</body> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="dev/bitbite/networking/package-summary.html">Non-frame version</a>.</p> + + diff --git a/doc/overview-tree.html b/doc/overview-tree.html index 37f9e79..ca39679 100644 --- a/doc/overview-tree.html +++ b/doc/overview-tree.html @@ -1,43 +1,37 @@ - + - + Class Hierarchy - - - - + - - - - - - - - + + -
    - -
    -

    Hierarchy For All Packages

    Package Hierarchies: @@ -73,73 +76,64 @@

    Hierarchy For All Packages

    -

    Class Hierarchy

    -
    -

    Interface Hierarchy

    -
    -

    Enum Hierarchy

    -
    -
    - diff --git a/doc/package-list b/doc/package-list new file mode 100644 index 0000000..1598729 --- /dev/null +++ b/doc/package-list @@ -0,0 +1 @@ +dev.bitbite.networking diff --git a/doc/script.js b/doc/script.js index a54b757..b346356 100644 --- a/doc/script.js +++ b/doc/script.js @@ -1,124 +1,9 @@ -/* - * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. - * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - */ - -var moduleSearchIndex; -var packageSearchIndex; -var typeSearchIndex; -var memberSearchIndex; -var tagSearchIndex; -function loadScripts(doc, tag) { - createElem(doc, tag, 'script-dir/jszip/dist/jszip.js'); - createElem(doc, tag, 'script-dir/jszip-utils/dist/jszip-utils.js'); - if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || - window.navigator.userAgent.indexOf('Edge/') > 0) { - createElem(doc, tag, 'script-dir/jszip-utils/dist/jszip-utils-ie.js'); - } - createElem(doc, tag, 'search.js'); - - $.get(pathtoroot + "module-search-index.zip") - .done(function() { - JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { - JSZip.loadAsync(data).then(function(zip){ - zip.file("module-search-index.json").async("text").then(function(content){ - moduleSearchIndex = JSON.parse(content); - }); - }); - }); - }); - $.get(pathtoroot + "package-search-index.zip") - .done(function() { - JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { - JSZip.loadAsync(data).then(function(zip){ - zip.file("package-search-index.json").async("text").then(function(content){ - packageSearchIndex = JSON.parse(content); - }); - }); - }); - }); - $.get(pathtoroot + "type-search-index.zip") - .done(function() { - JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { - JSZip.loadAsync(data).then(function(zip){ - zip.file("type-search-index.json").async("text").then(function(content){ - typeSearchIndex = JSON.parse(content); - }); - }); - }); - }); - $.get(pathtoroot + "member-search-index.zip") - .done(function() { - JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { - JSZip.loadAsync(data).then(function(zip){ - zip.file("member-search-index.json").async("text").then(function(content){ - memberSearchIndex = JSON.parse(content); - }); - }); - }); - }); - $.get(pathtoroot + "tag-search-index.zip") - .done(function() { - JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { - JSZip.loadAsync(data).then(function(zip){ - zip.file("tag-search-index.json").async("text").then(function(content){ - tagSearchIndex = JSON.parse(content); - }); - }); - }); - }); - if (!moduleSearchIndex) { - createElem(doc, tag, 'module-search-index.js'); - } - if (!packageSearchIndex) { - createElem(doc, tag, 'package-search-index.js'); - } - if (!typeSearchIndex) { - createElem(doc, tag, 'type-search-index.js'); - } - if (!memberSearchIndex) { - createElem(doc, tag, 'member-search-index.js'); - } - if (!tagSearchIndex) { - createElem(doc, tag, 'tag-search-index.js'); - } - $(window).resize(function() { - $('.navPadding').css('padding-top', $('.fixedNav').css("height")); - }); -} - -function createElem(doc, tag, path) { - var script = doc.createElement(tag); - var scriptElement = doc.getElementsByTagName(tag)[0]; - script.src = pathtoroot + path; - scriptElement.parentNode.insertBefore(script, scriptElement); -} - -function show(type) { +function show(type) +{ count = 0; - for (var key in data) { + for (var key in methods) { var row = document.getElementById(key); - if ((data[key] & type) !== 0) { + if ((methods[key] & type) != 0) { row.style.display = ''; row.className = (count++ % 2) ? rowColor : altColor; } @@ -128,35 +13,18 @@ function show(type) { updateTabs(type); } -function updateTabs(type) { - var firstRow = document.getElementById(Object.keys(data)[0]); - var table = firstRow.closest('table'); +function updateTabs(type) +{ for (var value in tabs) { - var tab = document.getElementById(tabs[value][0]); + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; if (value == type) { - tab.className = activeTableTab; - tab.innerHTML = tabs[value][1]; - tab.setAttribute('aria-selected', true); - tab.setAttribute('tabindex',0); - table.setAttribute('aria-labelledby', tabs[value][0]); + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; } else { - tab.className = tableTab; - tab.setAttribute('aria-selected', false); - tab.setAttribute('tabindex',-1); - tab.setAttribute('onclick', "show("+ value + ")"); - tab.innerHTML = tabs[value][1]; + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; } } } - -function switchTab(e) { - if (e.keyCode == 37 || e.keyCode == 38) { - $("[aria-selected=true]").prev().click().focus(); - e.preventDefault(); - } - if (e.keyCode == 39 || e.keyCode == 40) { - $("[aria-selected=true]").next().click().focus(); - e.preventDefault(); - } -} diff --git a/src/dev/bitbite/networking/ServerListener.java b/src/dev/bitbite/networking/ServerListener.java index 29f321b..c573f80 100644 --- a/src/dev/bitbite/networking/ServerListener.java +++ b/src/dev/bitbite/networking/ServerListener.java @@ -88,6 +88,7 @@ public void onSocketClosed(Exception exception) {} /** * Will be fired if the ServerSocket is closed while Client tried to connect. * @param exception which is thrown during the process of client acceptance. + * @param clientAddress of the closed Socket */ public void onSocketClosed(Exception exception, String clientAddress) {} }