Allocator

Kotlin |Java

@UnstableApi
interface Allocator

Known direct subclasses

DefaultAllocator

Default implementation of Allocator.

A source of allocations.

Summary

Nested types
`interface Allocator.AllocationNode` A node in a chain of `Allocations`.

Public functions
`Allocation!`	`allocate()` Obtain an `Allocation`.
`Int`	`getIndividualAllocationLength()` Returns the length of each individual `Allocation`.
`Int`	`getTotalBytesAllocated()` Returns the total number of bytes currently allocated.
`Unit`	`release(allocation: Allocation!)` Releases an `Allocation` back to the allocator.
`Unit`	`release(allocationNode: Allocator.AllocationNode!)` Releases all `Allocations` in the chain starting at the given `AllocationNode`.
`Unit`	`trim()` Hints to the allocator that it should make a best effort to release any excess `Allocations`.

fun allocate(): Allocation!

Obtain an Allocation.

When the caller has finished with the Allocation, it should be returned by calling release.

Returns
`Allocation!`	The `Allocation`.

fun getIndividualAllocationLength(): Int

Returns the length of each individual Allocation.

fun getTotalBytesAllocated(): Int

Returns the total number of bytes currently allocated.

fun release(allocation: Allocation!): Unit

Releases an Allocation back to the allocator.

Parameters
`allocation: Allocation!`	The `Allocation` being released.

fun release(allocationNode: Allocator.AllocationNode!): Unit

Releases all Allocations in the chain starting at the given AllocationNode.

Implementations must not make memory allocations.

fun trim(): Unit

Hints to the allocator that it should make a best effort to release any excess Allocations.