Skip to content

Commit

Permalink
added a note about the meaning of the :timeout option in constructing…
Browse files Browse the repository at this point in the history
… a client.
  • Loading branch information
slyphon committed Apr 23, 2012
1 parent d0c18a7 commit c5549d9
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions lib/z_k/client/threaded.rb
Expand Up @@ -10,6 +10,13 @@ class Threaded < Base

DEFAULT_THREADPOOL_SIZE = 1

# @note The `:timeout` argument here is *not* the session_timeout for the
# connection. rather it is the amount of time we wait for the connection
# to be established. The session timeout exchanged with the server is
# set to 10s by default in the C implemenation, and as of version 0.8.0
# of slyphon-zookeeper has yet to be exposed as an option. That feature
# is planned.
#
# @param [String] host (see ZK::Client::Base#initialize)
#
# @option opts [Fixnum] :threadpool_size the size of the threadpool that
Expand Down

0 comments on commit c5549d9

Please sign in to comment.