diff options
author | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-04-16 17:04:28 -0700 |
---|---|---|
committer | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-04-16 17:04:28 -0700 |
commit | ee40c8641451a5bb4193d4729f378687e181abce (patch) | |
tree | 2bd0857ecde3c7787618a0939b648c99a73c1ed5 | |
parent | 39e7fef87b1ce40ec88b104aba250ae251ea7779 (diff) | |
download | pymemcache-ee40c8641451a5bb4193d4729f378687e181abce.tar.gz |
Add pooled client docstring
-rw-r--r-- | pymemcache/client.py | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/pymemcache/client.py b/pymemcache/client.py index 7f9339a..cd5304c 100644 --- a/pymemcache/client.py +++ b/pymemcache/client.py @@ -824,7 +824,18 @@ class Client(object): class PooledClient(object): - """A thread-safe pool of clients (with the same client api).""" + """A thread-safe pool of clients (with the same client api). + + :param max_pool_size: maximum pool size to use (going about this + amount triggers a runtime error), by default this + is 2147483648L when not provided. + :param lock_generator: a callback/type that takes no arguments that will + be called to create a lock or sempahore that can + protect the pool from concurrent + access (for example a eventlet lock or semaphore) + + Further arguments are interpreted as for :py:class:`.Client` constructor. + """ def __init__(self, server, |