Skip to content

Commit c7dda58

Browse files
Revise wording in CommonMuxPool KDoc (#81)
2 parents 78cfbc6 + 1f85c97 commit c7dda58

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

pushiko-pools/src/main/kotlin/com/bloomberg/pushiko/pool/CommonMuxPool.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,17 @@ import kotlin.coroutines.resumeWithException
6161
/**
6262
* A non-blocking, lock-free pool that maintains a minimum number of pooled multiplexers even in the absence of
6363
* demand, heuristically scheduling the creation of new objects if need be and if the headroom exists to do so even
64-
* when there may be capacity available elsewhere. When no further aggregate capacity is available further acquisition
65-
* attempts are treated as pending and their associated continuations buffer up over the pool, only resuming when
66-
* capacity becomes available again. If there are too many queued pending acquisitions the pool begins failing the
67-
* oldest of these by resuming the associated continuation with an exception.
64+
* when there may be capacity available. When no further aggregate capacity is available further acquisition attempts
65+
* are treated as pending and their associated continuations buffer up over the pool, only resuming when capacity
66+
* becomes available again. If there are too many queued pending acquisitions the pool begins failing the oldest of
67+
* these by resuming the associated continuation with an exception.
6868
*
6969
* The acquisition, creation (or not) and release of objects - in other words, the state of the pool - is entirely
7070
* confined to the pool and orchestrated from a coroutine dispatcher backed exclusively by a single dedicated thread.
7171
* Intensive or blocking work on this thread would stop the world and is always avoided. Once acquired, the use of a
7272
* borrowed object is offloaded at the earliest opportunity and the object is released immediately after its
7373
* acquisition for further acquisition without awaiting the conclusion of the work. The work using a borrowed object
74-
* may fail but always do so in isolation without affecting another.
74+
* may fail but always does so in isolation without affecting another.
7575
*
7676
* The closing of the pool is orderly and is triggered by calling [close] which cancels the control job underpinning
7777
* the pool's work. Once this is initiated subsequent acquisition attempts will fail and promptly meet with an

0 commit comments

Comments
 (0)