io.atomix.catalyst.buffer.util.MemoryAllocator Maven / Gradle / Ivy
/*
* Copyright 2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.atomix.catalyst.buffer.util;
import io.atomix.catalyst.buffer.Bytes;
/**
* Memory allocator.
*
* Memory allocators handle allocation of memory for {@link Bytes} objects, providing descriptors
* that point to memory addresses.
*
* @author Jordan Halterman
*/
public interface MemoryAllocator {
/**
* Allocates memory.
*
* @param size The count of the memory to allocate.
* @return The allocated memory.
*/
T allocate(long size);
/**
* Reallocates the given memory.
*
* When the memory is reallocated, the memory address for the given {@link Memory} instance may change. The returned
* {@link Memory} instance will contain the updated address and count.
*
* @param memory The memory to reallocate.
* @param size The count to which to reallocate the given memory.
* @return The reallocated memory.
*/
T reallocate(T memory, long size);
}