ktor-io/io.ktor.utils.io.pool/DefaultPool

DefaultPool

expect abstract class DefaultPool<T : Any>(capacity: Int) : ObjectPool<T>

Default object pool implementation.

Inheritors

DefaultBufferPool

actual abstract class DefaultPool<T : Any>(val capacity: Int) : ObjectPool<T>

actual abstract class DefaultPool<T : Any>(val capacity: Int)

Inheritors

ByteBufferPool

DirectByteBufferPool

actual abstract class DefaultPool<T : Any>(val capacity: Int) : ObjectPool<T>

Constructors

DefaultPool

expect constructor(capacity: Int)

actual constructor(capacity: Int)

Types

Companion

object Companion

Properties

allocated

val allocated: Int

capacity

expect override val capacity: Int

Pool capacity.

actual override val capacity: Int

Pool capacity

actual val capacity: Int

actual override val capacity: Int

Pool capacity

val inCache: Int

val inUsed: Int

val recycled: Int

val released: Int

Functions

borrow

expect override fun borrow(): T

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

actual override fun borrow(): T

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

actual fun borrow(): T

actual override fun borrow(): T

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

open override fun close()

Does pool dispose

open override fun close()

Does pool dispose

open override fun close()

Does pool dispose

dispose

expect override fun dispose()

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

actual override fun dispose()

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

actual fun dispose()

actual override fun dispose()

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

recycle

expect override fun recycle(instance: T)

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

actual override fun recycle(instance: T)

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

actual fun recycle(instance: T)

actual override fun recycle(instance: T)

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

useBorrowed

inline 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

inline 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