DefaultAllocator

Kotlin |Java

@UnstableApi
public final class DefaultAllocator implements Allocator

Default implementation of Allocator.

Summary

Public constructors
`DefaultAllocator(boolean trimOnReset, int individualAllocationSize)` Constructs an instance without creating any `Allocation`s up front.
`DefaultAllocator( boolean trimOnReset, int individualAllocationSize, int initialAllocationCount )` Constructs an instance with some `Allocation`s created up front.

Public methods
`synchronized Allocation`	`allocate()` Obtain an `Allocation`.
`int`	`getIndividualAllocationLength()` Returns the length of each individual `Allocation`.
`synchronized int`	`getTotalBytesAllocated()` Returns the total number of bytes currently allocated.
`synchronized void`	`release(Allocation allocation)` Releases an `Allocation` back to the allocator.
`synchronized void`	`release(@Nullable Allocator.AllocationNode allocationNode)` Releases all `Allocations` in the chain starting at the given `AllocationNode`.
`synchronized void`	`reset()`
`synchronized void`	`setTargetBufferSize(int targetBufferSize)`
`synchronized void`	`trim()` Hints to the allocator that it should make a best effort to release any excess `Allocations`.

public DefaultAllocator(boolean trimOnReset, int individualAllocationSize)

Constructs an instance without creating any Allocations up front.

Parameters
`boolean trimOnReset`	Whether memory is freed when the allocator is reset. Should be true unless the allocator will be re-used by multiple player instances. If set to false, trimming can be forced by calling `setTargetBufferSize` manually when required.
`int individualAllocationSize`	The length of each individual `Allocation`.

public DefaultAllocator(
    boolean trimOnReset,
    int individualAllocationSize,
    int initialAllocationCount
)

Constructs an instance with some Allocations created up front.

Note: Allocations created up front will never be discarded by trim.

Parameters
`boolean trimOnReset`	Whether memory is freed when the allocator is reset. Should be true unless the allocator will be re-used by multiple player instances. If set to false, trimming can be forced by calling `setTargetBufferSize` manually when required.
`int individualAllocationSize`	The length of each individual `Allocation`.
`int initialAllocationCount`	The number of allocations to create up front.

synchronized public Allocation allocate()

Obtain an Allocation.

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

Returns
`Allocation`	The `Allocation`.

public int getIndividualAllocationLength()

Returns the length of each individual Allocation.

synchronized public int getTotalBytesAllocated()

Returns the total number of bytes currently allocated.

synchronized public void release(Allocation allocation)

Releases an Allocation back to the allocator.

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

synchronized public void release(@Nullable Allocator.AllocationNode allocationNode)

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

Implementations must not make memory allocations.

synchronized public void reset()

synchronized public void setTargetBufferSize(int targetBufferSize)

synchronized public void trim()

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