SingleInstancePool

abstract class SingleInstancePool<T : Any> : ObjectPool<T>

A pool that produces at most one instance

Constructors

<init>

SingleInstancePool()

A pool that produces at most one instance

Properties

capacity

val capacity: Int

Pool capacity

Functions

borrow

fun borrow(): T

borrow an instance. Pool can recycle an old instance or create a new one

dispose

fun dispose(): Unit

Dispose the whole pool. None of borrowed objects could be used after the pool gets disposed otherwise it can result in undefined behaviour

disposeInstance

abstract fun disposeInstance(instance: T): Unit

Dispose instance and release it’s resources

produceInstance

abstract fun produceInstance(): T

Creates a new instance of T

recycle

fun recycle(instance: T): Unit

Recycle an instance. Should be recycled what was borrowed before otherwise could fail

Inherited Functions

close

open fun close(): Unit

Does pool dispose

Extension Functions

useBorrowed

fun <T : Any, R> ObjectPool<T>.useBorrowed(
    block: (T) -> R
): R

Borrows and instance of T from the pool, invokes block with it and finally recycles it

useInstance

fun <T : Any, R> ObjectPool<T>.useInstance(
    block: (T) -> R
): R

Borrows and instance of T from the pool, invokes block with it and finally recycles it