Changeset 33749 in project

Timestamp:

11/19/16 15:02:07 (21 months ago)

Author:

sjamaan

Message:

Document new http-client parameter and procedure.

File:

• wiki/eggref/4/http-client (modified) (2 diffs)

wiki/eggref/4/http-client

@@ -238 +238 @@
 ==== Connection management
 
+This egg tries to re-use connections that are marked as keep-alive, to
+avoid unnecessary overhead in establishing new connections when making
+multiple requests to the same server.  This is handled through a pool
+of idle connections from which the request procedures take the oldest
+active connection.
+
+<parameter>(max-idle-connections [count])</parameter>
+
+This controls the maximum allowed idle connections at any given time.
+When a connection would be returned to the pool, the connection will
+be discarded instead, if the maximum is exceeded.
+
+This value should always be well below the maximum number of available
+file descriptors for your operating system.
+
+Defaults to {{32}}.
+
+
 <procedure>(close-connection! uri)</procedure>
 
 Close the connection to the server associated with the URI.
 
+<procedure>(close-idle-connections!)</procedure>
+
+Close all remaining idle connections.  Note that connections that are
+currently in use will still be returned to the connection pool after
+their requests finish!
+
 <procedure>(close-all-connections!)</procedure>
 
-Close all connections to all servers.
+Deprecated alias for {{close-idle-connections!}}.
 
 ==== Setting up custom server connections
@@ -487 +511 @@
 === Changelog
 
+* trunk Add {{max-idle-connections}} to avoid FD exhaustion (thanks to [[/users/alaric-blagrave-snellpym|Alaric]] for pointing out this issue).
 * 0.10 Do not read {{HTTP_PROXY}} if {{REQUEST_METHOD}} is present (running in a CGI script), to prevent "[[https://httpoxy.org|httpoxy]]" attack (CVE-2016-6287).
 * 0.9 Add support for custom connector procedures.  Thanks to Ryan Senior for suggesting support for https client certificates, which this makes possible.