org.apache.flink.core.memory

Interface MemorySegmentFactory.Factory

All Known Implementing Classes:

HeapMemorySegment.HeapMemorySegmentFactory, HybridMemorySegment.HybridMemorySegmentFactory

Enclosing class:

MemorySegmentFactory

public static interface MemorySegmentFactory.Factory

A concrete factory for memory segments.

Method Summary

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

Method Detail

wrap

MemorySegment wrap(byte[] memory)

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

Parameters:

memory - The heap memory region.

Returns:

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

allocateUnpooledSegment

MemorySegment allocateUnpooledSegment(int size,
                                      Object owner)

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

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

MemorySegment wrapPooledHeapMemory(byte[] memory,
                                   Object owner)

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.

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

MemorySegment wrapPooledOffHeapMemory(ByteBuffer memory,
                                      Object owner)

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.

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.