Package org.apache.bookkeeper.common.allocator.impl

Class ByteBufAllocatorBuilderImpl

java.lang.Object

org.apache.bookkeeper.common.allocator.impl.ByteBufAllocatorBuilderImpl

All Implemented Interfaces:

ByteBufAllocatorBuilder

public class ByteBufAllocatorBuilderImpl
extends java.lang.Object
implements ByteBufAllocatorBuilder

Implementation of ByteBufAllocatorBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) LeakDetectionPolicy	leakDetectionPolicy
(package private) java.util.function.Consumer<java.lang.OutOfMemoryError>	outOfMemoryListener
(package private) OutOfMemoryPolicy	outOfMemoryPolicy
(package private) io.netty.buffer.ByteBufAllocator	pooledAllocator
(package private) int	poolingConcurrency
(package private) PoolingPolicy	poolingPolicy
(package private) io.netty.buffer.ByteBufAllocator	unpooledAllocator

Constructor Summary

Constructors

Constructor	Description
ByteBufAllocatorBuilderImpl()

Method Summary

Modifier and Type	Method	Description
ByteBufAllocatorWithOomHandler	build()	Finalize the configured ByteBufAllocator.
ByteBufAllocatorBuilder	leakDetectionPolicy(LeakDetectionPolicy leakDetectionPolicy)	Enable the leak detection for the allocator.
ByteBufAllocatorBuilder	outOfMemoryListener(java.util.function.Consumer<java.lang.OutOfMemoryError> listener)	Add a listener that is triggered whenever there is an allocation failure.
ByteBufAllocatorBuilder	outOfMemoryPolicy(OutOfMemoryPolicy policy)	Define the OutOfMemory handling policy.
ByteBufAllocatorBuilder	pooledAllocator(io.netty.buffer.ByteBufAllocator pooledAllocator)	Specify a custom allocator where the allocation requests should be forwarded to.
ByteBufAllocatorBuilder	poolingConcurrency(int poolingConcurrency)	Controls the amount of concurrency for the memory pool.
ByteBufAllocatorBuilder	poolingPolicy(PoolingPolicy policy)	Define the memory pooling policy.
ByteBufAllocatorBuilder	unpooledAllocator(io.netty.buffer.ByteBufAllocator unpooledAllocator)	Specify a custom allocator where the allocation requests should be forwarded to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pooledAllocator

io.netty.buffer.ByteBufAllocator pooledAllocator

unpooledAllocator

io.netty.buffer.ByteBufAllocator unpooledAllocator

poolingPolicy

PoolingPolicy poolingPolicy

poolingConcurrency

int poolingConcurrency

outOfMemoryPolicy

OutOfMemoryPolicy outOfMemoryPolicy

outOfMemoryListener

java.util.function.Consumer<java.lang.OutOfMemoryError> outOfMemoryListener

leakDetectionPolicy

LeakDetectionPolicy leakDetectionPolicy

Constructor Detail

ByteBufAllocatorBuilderImpl

public ByteBufAllocatorBuilderImpl()

Method Detail

build

public ByteBufAllocatorWithOomHandler build()

Description copied from interface: ByteBufAllocatorBuilder

Finalize the configured ByteBufAllocator.

Specified by:

build in interface ByteBufAllocatorBuilder

pooledAllocator

public ByteBufAllocatorBuilder pooledAllocator(io.netty.buffer.ByteBufAllocator pooledAllocator)

Description copied from interface: ByteBufAllocatorBuilder

Specify a custom allocator where the allocation requests should be forwarded to.

Default is to use a new instance of PooledByteBufAllocator.

Specified by:

pooledAllocator in interface ByteBufAllocatorBuilder

unpooledAllocator

public ByteBufAllocatorBuilder unpooledAllocator(io.netty.buffer.ByteBufAllocator unpooledAllocator)

Description copied from interface: ByteBufAllocatorBuilder

Specify a custom allocator where the allocation requests should be forwarded to.

Default is to use UnpooledByteBufAllocator.DEFAULT.

Specified by:

unpooledAllocator in interface ByteBufAllocatorBuilder

poolingPolicy

public ByteBufAllocatorBuilder poolingPolicy(PoolingPolicy policy)

Description copied from interface: ByteBufAllocatorBuilder

Define the memory pooling policy.

Default is PoolingPolicy.PooledDirect

Specified by:

poolingPolicy in interface ByteBufAllocatorBuilder

poolingConcurrency

public ByteBufAllocatorBuilder poolingConcurrency(int poolingConcurrency)

Description copied from interface: ByteBufAllocatorBuilder

Controls the amount of concurrency for the memory pool.

Default is to have a number of allocator arenas equals to 2 * CPUS.

Decreasing this number will reduce the amount of memory overhead, at the expense of increased allocation contention.

Specified by:

poolingConcurrency in interface ByteBufAllocatorBuilder

outOfMemoryPolicy

public ByteBufAllocatorBuilder outOfMemoryPolicy(OutOfMemoryPolicy policy)

Description copied from interface: ByteBufAllocatorBuilder

Define the OutOfMemory handling policy.

Default is OutOfMemoryPolicy.FallbackToHeap

Specified by:

outOfMemoryPolicy in interface ByteBufAllocatorBuilder

outOfMemoryListener

public ByteBufAllocatorBuilder outOfMemoryListener(java.util.function.Consumer<java.lang.OutOfMemoryError> listener)

Description copied from interface: ByteBufAllocatorBuilder

Add a listener that is triggered whenever there is an allocation failure.

Application can use this to trigger alerting or process restarting.

Specified by:

outOfMemoryListener in interface ByteBufAllocatorBuilder

leakDetectionPolicy

public ByteBufAllocatorBuilder leakDetectionPolicy(LeakDetectionPolicy leakDetectionPolicy)

Description copied from interface: ByteBufAllocatorBuilder

Enable the leak detection for the allocator.

Default is LeakDetectionPolicy.Disabled

Specified by:

leakDetectionPolicy in interface ByteBufAllocatorBuilder