ObjectPool/src/dorkbox/objectPool/blocking/BlockingPoolCollection.kt

77 lines
2.1 KiB
Kotlin

/*
* Copyright 2020 dorkbox, llc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package dorkbox.objectPool.blocking
import dorkbox.objectPool.Pool
import java.util.concurrent.*
/**
* A blocking pool of a specific collection, where the entire pool is initially filled, and when the pool is empty,
* a [Pool.take] will wait for a corresponding [Pool.put].
*
* @author dorkbox, llc
*/
internal class BlockingPoolCollection<T> constructor(
private val queue: BlockingQueue<T>,
collection: Collection<T>) : Pool<T> {
private val dummyValue: T
init {
dummyValue = collection.elementAt(0)
for (it in collection) {
queue.offer(it)
}
}
/**
* Takes an object from the pool, Blocks until an item is available in the pool.
*
* This method catches [InterruptedException] and discards it silently.
*/
override fun take(): T {
return try {
takeInterruptibly()
} catch (ignored: InterruptedException) {
dummyValue
}
}
/**
* Takes an object from the pool, Blocks until an item is available in the pool.
*
* @throws InterruptedException
*/
override fun takeInterruptibly(): T {
return queue.take()
}
/**
* Return object to the pool, waking the threads that have blocked during take()
*/
override fun put(`object`: T) {
queue.put(`object`)
}
/**
* @return a new object instance created by the pool.
*/
override fun newInstance(): T {
return dummyValue
}
}