summaryrefslogtreecommitdiffstats
path: root/docs/api/PoolStats.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/PoolStats.md')
-rw-r--r--docs/api/PoolStats.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/api/PoolStats.md b/docs/api/PoolStats.md
new file mode 100644
index 0000000..16b6dc2
--- /dev/null
+++ b/docs/api/PoolStats.md
@@ -0,0 +1,35 @@
+# Class: PoolStats
+
+Aggregate stats for a [Pool](Pool.md) or [BalancedPool](BalancedPool.md).
+
+## `new PoolStats(pool)`
+
+Arguments:
+
+* **pool** `Pool` - Pool or BalancedPool from which to return stats.
+
+## Instance Properties
+
+### `PoolStats.connected`
+
+Number of open socket connections in this pool.
+
+### `PoolStats.free`
+
+Number of open socket connections in this pool that do not have an active request.
+
+### `PoolStats.pending`
+
+Number of pending requests across all clients in this pool.
+
+### `PoolStats.queued`
+
+Number of queued requests across all clients in this pool.
+
+### `PoolStats.running`
+
+Number of currently active requests across all clients in this pool.
+
+### `PoolStats.size`
+
+Number of active, pending, or queued requests across all clients in this pool.