From 92fb3768bf0be80e186d4fe2b606adfbab45c0e5 Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Wed, 2 Oct 2024 15:09:34 +0200 Subject: [PATCH 1/3] Clarify the backlog option --- README.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.markdown b/README.markdown index 2b2d2b251d..94468a266e 100644 --- a/README.markdown +++ b/README.markdown @@ -7989,14 +7989,14 @@ An optional Lua table can be specified as the last argument to this method to sp * `backlog` if specified, this module will limit the total number of opened connections for this pool. No more connections than `pool_size` can be opened - for this pool at any time. If the connection pool is full, subsequent - connect operations will be queued into a queue equal to this option's - value (the "backlog" queue). + for this pool at any time. If `pool_size` number of connections are in use, + subsequent connect operations will be queued into a queue equal to this + option's value (the "backlog" queue). If the number of queued connect operations is equal to `backlog`, subsequent connect operations will fail and return `nil` plus the error string `"too many waiting connect operations"`. - The queued connect operations will be resumed once the number of connections - in the pool is less than `pool_size`. + The queued connect operations will be resumed once the number of active + connections becomes less than `pool_size`. The queued connect operation will abort once they have been queued for more than `connect_timeout`, controlled by [settimeouts](#tcpsocksettimeouts), and will return `nil` plus From 5c27d6e5d49e468cc787e4e4a9fff841e2ee9962 Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Wed, 2 Oct 2024 15:12:10 +0200 Subject: [PATCH 2/3] fix whitespace --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 94468a266e..66db264197 100644 --- a/README.markdown +++ b/README.markdown @@ -7996,7 +7996,7 @@ An optional Lua table can be specified as the last argument to this method to sp subsequent connect operations will fail and return `nil` plus the error string `"too many waiting connect operations"`. The queued connect operations will be resumed once the number of active - connections becomes less than `pool_size`. + connections becomes less than `pool_size`. The queued connect operation will abort once they have been queued for more than `connect_timeout`, controlled by [settimeouts](#tcpsocksettimeouts), and will return `nil` plus From 67638c239fc14ea902d3c30b29cb821cdd74e48e Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Wed, 2 Oct 2024 15:13:23 +0200 Subject: [PATCH 3/3] Update README.markdown --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 66db264197..d85a1f0753 100644 --- a/README.markdown +++ b/README.markdown @@ -7996,7 +7996,7 @@ An optional Lua table can be specified as the last argument to this method to sp subsequent connect operations will fail and return `nil` plus the error string `"too many waiting connect operations"`. The queued connect operations will be resumed once the number of active - connections becomes less than `pool_size`. + connections becomes less than `pool_size`. The queued connect operation will abort once they have been queued for more than `connect_timeout`, controlled by [settimeouts](#tcpsocksettimeouts), and will return `nil` plus