add comment

mamantoha · Jul 26, 2024 · 8b71f2d · 8b71f2d
1 parent 1c92ed7
commit 8b71f2d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/http/proxy/server.cr b/src/http/proxy/server.cr
@@ -70,6 +70,11 @@ class HTTP::Proxy::Server
     handlers.first
   end
 
+  # Creates a `TCPServer` listening on `host:port` and adds it as a socket, returning the local address
+  # and port the server listens on.
+  #
+  # If *reuse_port* is `true`, it enables the `SO_REUSEPORT` socket option,
+  # which allows multiple processes to bind to the same port.
   def bind_tcp(host : String, port : Int32, reuse_port : Bool = false) : Socket::IPAddress
     tcp_server = TCPServer.new(host, port, reuse_port: reuse_port)