Updated Backlog Documentation

Updated Backlog Documentation

Author: Katsute

src/main/java/com/kttdevelopment/simplehttpserver/SimpleHttpServer.java

@@ -68,7 +68,7 @@ public static SimpleHttpServer create(final int port) throws IOException {
      * Creates a {@link SimpleHttpServer} bounded to a port.
      *
      * @param port port to bind to
-     * @param backlog request backlog
+     * @param backlog maximum amount of inbound connections allowed
      * @return a {@link SimpleHttpServer}
      * @throws java.net.BindException if server can not bind to port
      * @throws NullPointerException if address is <code>null</code>
@@ -119,7 +119,7 @@ public static SimpleHttpServer create(final int port, final int backlog) throws
      * Binds the server to a port.
      *
      * @param port port to bind the server to
-     * @param backlog request backlog
+     * @param backlog maximum amount of inbound connections allowed
      * @return address the server is binded to
      * @throws java.net.BindException if server could not be bound to port, or if it's already bound
      * @throws IllegalArgumentException if port is out of range
@@ -156,7 +156,7 @@ public static SimpleHttpServer create(final int port, final int backlog) throws
      * Binds the server to a port.
      *
      * @param addr address to bind the server to
-     * @param backlog request backlog
+     * @param backlog maximum amount of inbound connections allowed
      * @throws java.net.BindException if server could not be bound to port, or if it's already bound
      * @throws NullPointerException if address is <code>null</code>
      * @throws IOException uncaught exception

src/main/java/com/kttdevelopment/simplehttpserver/SimpleHttpServerImpl.java

@@ -31,7 +31,7 @@ final class SimpleHttpServerImpl extends SimpleHttpServer {
      * Creates a {@link SimpleHttpServer}.
      *
      * @param port port to run the server on
-     * @param backlog how many requests to backlog
+     * @param backlog maximum amount of inbound connections allowed
      * @return a {@link SimpleHttpServer}
      * @throws java.net.BindException if server can not bind to port
      * @throws IOException uncaught exception

src/main/java/com/kttdevelopment/simplehttpserver/SimpleHttpsServer.java

@@ -5,7 +5,8 @@
 import java.io.IOException;
 
 /**
- * <i>This class is a simplified implementation of {@link HttpsServer}.</i><br>
+ * <i>This class is a simplified implementation of {@link HttpsServer}.</i>
+ * The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.<br>
  * At least one {@link HttpHandler} must be created in order to process requests. When handling requests the server will use the most specific context. If no handler can be found it is rejected with a 404 response. <br>
  * <b>Contexts are case-sensitive.</b>
  *
@@ -31,7 +32,7 @@ public abstract class SimpleHttpsServer extends SimpleHttpServer {
 //
 
    /**
-    * Creates a {@link SimpleHttpsServer}.
+    * Creates a {@link SimpleHttpsServer}. The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.
     *
     * @return a {@link SimpleHttpsServer}
     * @throws IOException uncaught exception
@@ -44,7 +45,7 @@ public static SimpleHttpsServer create() throws IOException {
    }
 
    /**
-    * Creates a {@link SimpleHttpsServer} bounded to a port.
+    * Creates a {@link SimpleHttpsServer} bounded to a port. The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.
     *
     * @param port port to bind to
     * @return a {@link SimpleHttpsServer}
@@ -61,10 +62,10 @@ public static SimpleHttpsServer create(final int port) throws IOException {
    }
 
    /**
-    * Creates a {@link SimpleHttpsServer} bounded to a port.
+    * Creates a {@link SimpleHttpsServer} bounded to a port. The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.
     *
     * @param port port to bind to
-    * @param backlog request backlog
+    * @param backlog maximum amount of inbound connections allowed
     * @return a {@link SimpleHttpsServer}
     * @throws java.net.BindException if server can not bind to port
     * @throws NullPointerException if address is <code>null</code>