org.apache.flink.core.memory

Class HybridMemorySegment.HybridMemorySegmentFactory

java.lang.Object

org.apache.flink.core.memory.HybridMemorySegment.HybridMemorySegmentFactory

All Implemented Interfaces:

MemorySegmentFactory.Factory

Enclosing class:

HybridMemorySegment

public static final class HybridMemorySegment.HybridMemorySegmentFactory
extends Object
implements MemorySegmentFactory.Factory

Base factory for hybrid memory segments.

Method Summary

Modifier and Type	Method and Description
HybridMemorySegment	allocateUnpooledSegment(int size, Object owner) Allocates some unpooled memory and creates a new memory segment that represents that memory.
HybridMemorySegment	wrap(byte[] memory) Creates a new memory segment that targets the given heap memory region.
HybridMemorySegment	wrapPooledHeapMemory(byte[] memory, Object owner) Creates a memory segment that wraps the given byte array.
HybridMemorySegment	wrapPooledOffHeapMemory(ByteBuffer memory, Object owner) Creates a memory segment that wraps the off-heap memory backing the given ByteBuffer.

Methods inherited from class java.lang.Object

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

Method Detail

wrap

public HybridMemorySegment wrap(byte[] memory)

Description copied from interface: MemorySegmentFactory.Factory

Creates a new memory segment that targets the given heap memory region.

Specified by:

wrap in interface MemorySegmentFactory.Factory

Parameters:

memory - The heap memory region.

Returns:

A new memory segment that targets the given heap memory region.

allocateUnpooledSegment

public HybridMemorySegment allocateUnpooledSegment(int size,
                                                   Object owner)

Description copied from interface: MemorySegmentFactory.Factory

Allocates some unpooled memory and creates a new memory segment that represents that memory.

Specified by:

allocateUnpooledSegment in interface MemorySegmentFactory.Factory

Parameters:

size - The size of the memory segment to allocate.

owner - The owner to associate with the memory segment.

Returns:

A new memory segment, backed by unpooled heap memory.

wrapPooledHeapMemory

public HybridMemorySegment wrapPooledHeapMemory(byte[] memory,
                                                Object owner)

Description copied from interface: MemorySegmentFactory.Factory

Creates a memory segment that wraps the given byte array.

This method is intended to be used for components which pool memory and create memory segments around long-lived memory regions.

Specified by:

wrapPooledHeapMemory in interface MemorySegmentFactory.Factory

Parameters:

memory - The heap memory to be represented by the memory segment.

owner - The owner to associate with the memory segment.

Returns:

A new memory segment representing the given heap memory.

wrapPooledOffHeapMemory

public HybridMemorySegment wrapPooledOffHeapMemory(ByteBuffer memory,
                                                   Object owner)

Description copied from interface: MemorySegmentFactory.Factory

Creates a memory segment that wraps the off-heap memory backing the given ByteBuffer. Note that the ByteBuffer needs to be a direct ByteBuffer.

This method is intended to be used for components which pool memory and create memory segments around long-lived memory regions.

Specified by:

wrapPooledOffHeapMemory in interface MemorySegmentFactory.Factory

Parameters:

memory - The byte buffer with the off-heap memory to be represented by the memory segment.

owner - The owner to associate with the memory segment.

Returns:

A new memory segment representing the given off-heap memory.