mirror of
https://github.com/mperham/connection_pool
synced 2023-03-27 23:22:21 -04:00
Merge pull request #57 from rbishop/make-comments-coherent
Move docs for TimedStack to just above the TimedStack class definition
This commit is contained in:
commit
6af7c1290b
1 changed files with 8 additions and 8 deletions
|
@ -4,7 +4,14 @@ require 'timeout'
|
||||||
##
|
##
|
||||||
# Raised when you attempt to retrieve a connection from a pool that has been
|
# Raised when you attempt to retrieve a connection from a pool that has been
|
||||||
# shut down.
|
# shut down.
|
||||||
#
|
|
||||||
|
class ConnectionPool::PoolShuttingDownError < RuntimeError; end
|
||||||
|
|
||||||
|
##
|
||||||
|
# The TimedStack manages a pool of homogeneous connections (or any resource
|
||||||
|
# you wish to manage). Connections are created lazily up to a given maximum
|
||||||
|
# number.
|
||||||
|
|
||||||
# Examples:
|
# Examples:
|
||||||
#
|
#
|
||||||
# ts = TimedStack.new(1) { MyConnection.new }
|
# ts = TimedStack.new(1) { MyConnection.new }
|
||||||
|
@ -19,13 +26,6 @@ require 'timeout'
|
||||||
# ts.pop timeout: 5
|
# ts.pop timeout: 5
|
||||||
# #=> raises Timeout::Error after 5 seconds
|
# #=> raises Timeout::Error after 5 seconds
|
||||||
|
|
||||||
class ConnectionPool::PoolShuttingDownError < RuntimeError; end
|
|
||||||
|
|
||||||
##
|
|
||||||
# The TimedStack manages a pool of homogeneous connections (or any resource
|
|
||||||
# you wish to manage). Connections are created lazily up to a given maximum
|
|
||||||
# number.
|
|
||||||
|
|
||||||
class ConnectionPool::TimedStack
|
class ConnectionPool::TimedStack
|
||||||
|
|
||||||
##
|
##
|
||||||
|
|
Loading…
Reference in a new issue